
OBS MCP Server

2025.03.24
8
TypeScript直播控制视频录制流媒体管理浏览器自动化娱乐功能
OBS MCP Server 是一个用于 OBS Studio 的 MCP 服务器,通过 OBS WebSocket 协议提供控制 OBS 的工具。它允许用户通过 MCP 工具进行各种操作,包括场景管理、源控制、场景项操作、流媒体和录制控制以及过渡效果设置等。
View on GitHub
Overview
基本能力
产品定位
OBS MCP Server 是一个专门为 OBS Studio 设计的 MCP 服务器,旨在通过 WebSocket 协议提供对 OBS 的远程控制能力。
核心功能
- 连接到 OBS WebSocket 服务器
- 通过 MCP 工具控制 OBS
- 提供多种工具,包括:
- 常规操作
- 场景管理
- 源控制
- 场景项操作
- 流媒体和录制控制
- 过渡效果设置
适用场景
- 直播控制自动化
- 视频录制流程管理
- 场景和源的高级控制
- 流媒体工作流优化
工具列表
- 常规工具:版本信息、统计信息、热键、工作室模式
- 场景工具:列出场景、切换场景、创建/删除场景
- 源工具:管理源、设置、音频级别、静音/取消静音
- 场景项工具:管理场景中的项(位置、可见性等)
- 流媒体工具:开始/停止流媒体、录制、虚拟摄像头
- 过渡工具:设置过渡、持续时间、触发过渡
常见问题解答
- Q: 如何设置 WebSocket 密码?
A: 通过环境变量
OBS_WEBSOCKET_PASSWORD
设置。 - Q: 如何连接到不同的 WebSocket URL?
A: 通过环境变量
OBS_WEBSOCKET_URL
设置。
使用教程
使用依赖
- Node.js 16+
- OBS Studio 31+ 并启用 WebSocket 服务器
- Claude desktop
安装教程
npm install
npm run build
调试方式
- 确保 OBS Studio 正在运行并启用了 WebSocket 服务器(工具 > WebSocket 服务器设置)。记下 WS 的密码。
- 设置 WebSocket 密码环境变量(如果需要):
export OBS_WEBSOCKET_PASSWORD="your_password_here"
- 运行 OBS MCP 服务器以确认其能够构建和连接:
npm run build
npm run start
- 在 Claude desktop 中配置 MCP 服务器设置:
{
"mcpServers": {
"obs": {
"command": "node",
"args": [
"<obs-mcp_root>/build/index.js"
],
"env": {
"OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
}
}
}
}
- 使用 Claude 控制您的 OBS!