这是一个为 OBS Studio 提供通过 OBS WebSocket 协议控制 OBS 的工具的 MCP 服务器。

特色

• 连接OBS WebSocket服务器
• 通过MCP工具控制OBS
• 提供以下工具：
• 一般运营
• 场景管理
• 源控
• 场景物品操作
• 流媒体与录制
• 过渡

用途

1. 确保 OBS Studio 启用了 WebSocket 服务器（工具> WebSocket 服务器设置）。注意 WS 的密码。

2. 在环境变量中设置WebSocket密码（如有需要）：

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

4. 用Claude来控制你的OBS！

发展

如果你想用这个git仓库里的代码本地运行服务器，可以这样做：

然后配置Claude桌面：

可用工具

服务器提供按类别分类的工具：

• 通用工具：版本信息、统计、快捷键、工作室模式
• 场景工具：列表场景、切换场景、创建/移除场景
• 源工具：管理源码、设置、音量、静音/解除静音
• 场景物品工具：管理场景中的物品（位置、可见性等）
• 流媒体工具：开始/停止直播、录制、虚拟摄像头

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"

3. 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": ""
      }
    }
  }
}

4. 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.