OBS控制服务器

一个通过WebSocket协议控制OBS Studio的MCP服务器,提供场景管理、源控制、流媒体操作等功能。

  • by royshil
  • TypeScript
  • 本地部署
  • 147 星标
  • 更新于
在 GitHub 查看 royshil/obs-mcp

使用说明

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"
  1. 使用MCP服务器设置将MCP服务器添加到Claude桌面:
{
  "mcpServers": {
    "obs": {
      "command": "npx",
      "args": ["-y", "obs-mcp@latest"],
      "env": {
        "OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
      }
    }
  }
}
  1. 使用克劳德来控制你的OBS!

发展

如果您想使用此git repo中的代码在本地运行服务器,可以执行以下操作:

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服务器
  • 克劳德桌面

许可证

请参阅 许可证 文件以获取详细信息。