
Obs Mcp
一个用于 OBS 的 MCP 服务器
概述
OBS MCP 服务器
一个为 OBS Studio 提供的 MCP 服务器,可通过 OBS WebSocket 协议控制 OBS。
功能特性
- 连接至 OBS WebSocket 服务器
- 通过 MCP 工具控制 OBS
- 提供以下工具集:
- 常规操作
- 场景管理
- 源控制
- 场景项操作
- 直播与录制
- 转场效果
安装指南
bash
npm install
npm run build
使用说明
- 确保 OBS Studio 已启用 WebSocket 服务器(工具 > WebSocket 服务器设置)。记录 WS 密码。
- 在环境变量中设置 WebSocket 密码(如需):
bash
export OBS_WEBSOCKET_PASSWORD="your_password_here"
- 运行 OBS MCP 服务器验证构建与连接:
bash
npm run build
npm run start
- 在 Claude 桌面端配置 MCP 服务器参数:
json
{
"mcpServers": {
"obs": {
"command": "node",
"args": [
"<obs-mcp_root>/build/index.js"
],
"env": {
"OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
}
}
}
}
- 通过 Claude 控制您的 OBS!
可用工具集
服务器按类别提供以下工具:
- 常规工具:版本信息、统计数据、热键、演播模式
- 场景工具:场景列表、场景切换、创建/删除场景
- 源工具:源管理、设置、音频电平、静音/取消静音
- 场景项工具:管理场景中的元素(位置、可见性等)
- 直播工具:开始/停止直播、录制、虚拟摄像头
- 转场工具:设置转场效果、持续时间、触发转场
环境变量
OBS_WEBSOCKET_URL
: WebSocket 地址(默认:ws://localhost:4455)OBS_WEBSOCKET_PASSWORD
: OBS WebSocket 认证密码(如需)
系统要求
- Node.js 16+
- OBS Studio 31+ 并启用 WebSocket 服务器
- Claude 桌面端
许可协议
详见 LICENSE 文件。