OBS MCP Server

OBS MCP 服务

一个用于 OBS Studio 的 MCP 服务，可通过 OBS WebSocket 协议控制 OBS。

功能

• 连接到 OBS WebSocket 服务
• 通过 MCP 工具控制 OBS
• 提供以下工具：
  • 常规操作
  • 场景管理
  • 来源控制
  • 场景项操作
  • 直播和录制
  • 转场

使用方法

1. 确保 OBS Studio 正在运行且已启用 WebSocket 服务（工具 > WebSocket 服务设置）。记下 WS 密码。
2. 如有需要，在环境变量中设置 WebSocket 密码：

export OBS_WEBSOCKET_PASSWORD="your_password_here"

3. 使用 MCP 服务设置，将 MCP 服务添加到 Claude 桌面应用：

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

4. 使用 Claude 控制 OBS！

开发

如果要使用此 git 仓库中的代码在本地运行服务，可以按以下步骤操作：

npm run build
npm run start

然后配置 Claude 桌面应用：

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

可用工具

该服务按类别提供工具：

• 常规工具：版本信息、统计信息、快捷键、工作室模式
• 场景工具：列出场景、切换场景、创建／移除场景
• 来源工具：管理来源、设置、音量、静音／取消静音
• 场景项工具：管理场景中的项目（位置、可见性等）
• 直播工具：开始／停止直播、录制、虚拟摄像头
• 转场工具：设置转场、时长、触发转场

环境变量

• OBS_WEBSOCKET_URL：WebSocket URL（默认：ws://localhost:4455）
• OBS_WEBSOCKET_PASSWORD：用于通过 OBS WebSocket 进行身份验证的密码（如有需要）

要求

• Node.js 16+
• OBS Studio 31+，并启用 WebSocket 服务
• Claude 桌面应用

许可证

详情请参阅 LICENSE 文件。