RO

royshil/obs-mcp

Developer tools

Эта страница переведена автоматически. Технические детали смотрите в оригинале. Открыть оригинал

152 stars 27 forks Качество 57 Тренд 18GPL-2.0

royshil/obs-mcp — это кандидат на сервер MCP, импортированный из https://github.com/royshil/obs-mcp.

Обзор

royshil/obs-mcp — это кандидат на сервер MCP, импортированный из https://github.com/royshil/obs-mcp.

Обзор (машинный перевод)

MCP-сервер для OBS Studio, предоставляющий инструменты для управления OBS через протокол OBS WebSocket.

Особенности

  • Подключение к серверу OBS WebSocket
  • Управление OBS с помощью инструментов MCP
  • Предоставляет инструменты для:
  • Общие операции
  • Управление сценами
  • Контроль исходных кодов
  • Манипуляция предметами сцены
  • Стриминг и запись
  • Переходы

Использование

  1. Убедитесь, что OBS Studio работает с включённым сервером WebSocket (Инструменты > настройках WebSocket Server). Обратите внимание на пароль для WS.

  2. Установите пароль WebSocket в переменной среды (если это необходимо):

  3. Добавить MCP-сервер на рабочий стол Claude с настройками MCP-сервера:

  4. Используйте Claude для управления своим OBS!

Развитие

Если вы хотите запустить сервер локально, используя код из этого git-репозиториума, вы можете сделать следующее:

Затем настройте рабочий стол Claude:

Доступные инструменты

Сервер предоставляет инструменты, организованные по категориям:

  • Общие инструменты: информация о версиях, статистика, горячие клавиши, режим студии
  • Инструменты сцены: перечисление сцен, переключение сцен, создание/удаление сцен
  • Инструменты исходного источника: управление источниками, настройками, уровнями звука, заглушение/включение звука
  • Инструменты элементов сцены: управление элементами в сценах (положение, видимость и т.д.)
  • Инструменты для стриминга: запуск/остановка стриминга, запись, виртуальная камера

Эта страница переведена автоматически. Технические детали смотрите в оригинале.

README

OBS MCP Server

An MCP server for OBS Studio that provides tools to control OBS via the OBS WebSocket protocol.

Features

  • Connect to OBS WebSocket server
  • Control OBS via MCP tools
  • Provides tools for:
    • General operations
    • Scene management
    • Source control
    • Scene item manipulation
    • Streaming and recording
    • Transitions

Usage

  1. Make sure OBS Studio is running with WebSocket server enabled (Tools > WebSocket Server Settings). Note the password for the WS.
  2. Set the WebSocket password in environment variable (if needed):
export OBS_WEBSOCKET_PASSWORD="your_password_here"
  1. Add the MCP server to Claude desktop with the MCP server settings:
{
  "mcpServers": {
    "obs": {
      "command": "npx",
      "args": ["-y", "obs-mcp@latest"],
      "env": {
        "OBS_WEBSOCKET_PASSWORD": ""
      }
    }
  }
}
  1. Use Claude to control your OBS!

Development

If you want to run the server locally using the code in this git repo, you can do the following:

npm run build
npm run start

Then configure Claude desktop:

{
  "mcpServers": {
    "obs": {
      "command": "node",
      "args": [
        "/build/index.js"
      ],
      "env": {
        "OBS_WEBSOCKET_PASSWORD": ""
      }
    }
  }
}

Available Tools

The server provides tools organized by category:

  • General tools: Version info, stats, hotkeys, studio mode
  • Scene tools: List scenes, switch scenes, create/remove scenes
  • Source tools: Manage sources, settings, audio levels, mute/unmute
  • Scene item tools: Manage items in scenes (position, visibility, etc.)
  • Streaming tools: Start/stop streaming, recording, virtual camera
  • Transition tools: Set transitions, durations, trigger transitions

Environment Variables

  • OBS_WEBSOCKET_URL: WebSocket URL (default: ws://localhost:4455)
  • OBS_WEBSOCKET_PASSWORD: Password for authenticating with OBS WebSocket (if required)

Requirements

  • Node.js 16+
  • OBS Studio 31+ with WebSocket server enabled
  • Claude desktop

License

See the LICENSE file for details.

Открыть полный README на GitHub

Установка

npx -y obs-mcp@latest
Новичок в MCP? Начните с руководства на mcpskill.org →

Конфигурация

{ "mcpServers": { "obs": { "command": "npx", "args": ["-y", "obs-mcp@latest"], "env": { "OBS_WEBSOCKET_PASSWORD": "<password_from_obs>" } } } }