JinDaGe - obs-mcp MCP Details

article

README

🚀 OBS MCP 服务器

OBS MCP 服务器是一款专为 OBS Studio 打造的工具，借助 OBS WebSocket 协议，能实现对 OBS 的便捷控制。

🚀 快速开始

OBS MCP 服务器可通过 OBS WebSocket 协议控制 OBS Studio。以下是使用前的准备步骤：

确保 OBS Studio 已运行并启用了 WebSocket 服务器（工具 > WebSocket 服务器设置），并记下密码。
设置 WebSocket 密码为环境变量（如果需要）：

export OBS_WEBSOCKET_PASSWORD="your_password_here"

运行 OBS MCP 服务器以确保其正常构建和连接：

npm install
npm run build
npm run start

配置您的 Claude 桌面以使用 MCP 服务器设置：

{
  "mcpServers": {
    "obs": {
      "command": "node",
      "args": [
        "<obs-mcp_root>/build/index.js"
      ],
      "env": {
        "OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
      }
    }
  }
}

使用 Claude 控制 OBS！

✨ 主要特性

可连接到 OBS WebSocket 服务器。
借助 MCP 工具实现对 OBS 的控制。
提供丰富的工具类别，涵盖通用操作、场景管理、源控制、场景项目操作、流媒体和录制以及转场等方面。

📦 安装指南

npm install
npm run build

💻 使用示例

基础用法

# 安装依赖
npm install
# 构建项目
npm run build
# 启动服务器
npm run start

高级用法

{
  "mcpServers": {
    "obs": {
      "command": "node",
      "args": [
        "<obs-mcp_root>/build/index.js"
      ],
      "env": {
        "OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
      }
    }
  }
}

此配置可用于在 Claude 桌面中使用 MCP 服务器来控制 OBS。

📚 详细文档

提供的工具

服务器按类别提供了以下工具：

通用工具：版本信息、统计信息、快捷键、工作室模式
场景工具：列出场景、切换场景、创建/删除场景
源工具：管理源、设置、音量电平、静音/取消静音
场景项目工具：管理场景中的项目（位置、可见性等）
流媒体工具：启动/停止流媒体、录制、虚拟摄像头
转场工具：设置转场、持续时间、触发转场

环境变量

| 属性 | 详情 | |------|------| | OBS_WEBSOCKET_URL | WebSocket URL（默认：ws://localhost:4455） | | OBS_WEBSOCKET_PASSWORD | 用于身份验证的 OBS WebSocket 密码（如果需要） |

要求

Node.js 16+
OBS Studio 31+，且已启用 WebSocket 服务器
Claude 桌面

📄 许可证

有关详细信息，请参阅 LICENSE 文件。

obs-mcp