OBS Studio MCP服务器
  ](https://github.com/sbroenne/mcp-server-obs/releases) 
A.NET 10 MCP(模型上下文协议)服务器,用于控制OBS Studio。它可以与任何MCP客户端单独使用,也可以通过附带的VS Code扩展使用。
⚠️ 该项目正在积极开发中。 API和功能可能会发生变化。
平台: 仅限Windows(OBS-WebSocket限制)
特性
通过人工智能助手(GitHub Copilot、Claude等)控制OBS Studio:
- 录制:开始、停止、暂停、恢复、配置格式/质量(默认情况下音频静音)
- 流媒体:启动、停止、监控状态
- 场景:列出和切换场景
- 来源:添加窗口捕获,管理可见性
- 音频:静音/取消静音输入,控制音量(桌面音频、麦克风)
- 窗口捕获:以编程方式选择要录制的窗口
- 媒体:屏幕截图、虚拟摄像头
安装
VS代码/VS代码内部人士(推荐)
直接从VS代码市场安装:

- 打开VS代码
- 转到扩展(
Ctrl+Shift+X) - 搜索 “OBS Studio MCP服务器”
- 点击 安装
或运行: code --install-extension sbroenne.obs-mcp
其他MCP客户端(Claude Desktop、Cursor、Windsurf等)
下载自 :
| 下载 | 说明 |
|---|---|
obs-mcp-server-*.zip | 需要 .NET 10运行时 |
提取并添加到MCP客户端配置中:
{
"servers": {
"obs": {
"command": "dotnet",
"args": ["C:/Tools/obs-mcp-server/Sbroenne.ObsMcp.McpServer.dll"],
"env": {
"OBS_HOST": "${input:obs_host}",
"OBS_PORT": "${input:obs_port}",
"OBS_PASSWORD": "${input:obs_password}"
}
}
},
"inputs": [
{
"id": "obs_host",
"type": "promptString",
"description": "OBS WebSocket host",
"default": "localhost"
},
{
"id": "obs_port",
"type": "promptString",
"description": "OBS WebSocket port",
"default": "4455"
},
{
"id": "obs_password",
"type": "promptString",
"description": "OBS WebSocket password",
"password": true
}
]
}配置文件位置:
| 客户端 | 路径 |
|---|---|
| 克劳德桌面 | %APPDATA%\Claude\claude_desktop_config.json |
| 光标 | ~/.cursor/mcp.json |
| 风帆冲浪 | ~/.codeium/windsurf/mcp_config.json |
先决条件
- OBS 工作室 -下载自 obsproject.com
- OBS WebSocket -内置于OBS工作室28.0+
启用OBS WebSocket
- 开放式OBS工作室
- 首选 工具 → WebSocket服务器设置
- 启用 WebSocket服务器
- 注意端口(默认值:
4455)和密码 - 点击 应用
可用工具
| 工具 | 操作 |
|---|---|
obs_connection | 连接、断开连接、获取状态、获取状态 |
obs_recording | 启动、停止、暂停、恢复、GetStatus、GetSettings、SetFormat、SetQuality、SetPath、GetPath |
obs_streaming | 启动、停止、获取状态 |
obs_scene | 列表、GetCurrent、Set、ListSources |
obs_source | 添加窗口捕获、列表窗口、设置窗口捕获、删除、设置启用 |
obs_audio | GetInputs、Mute、Unmute、GetMuteState、SetVolume、GetVolume、MuteAll、UnmuteAll |
obs_media | 保存屏幕截图,启动VirtualCamera,停止VirtualCamera |
注: 录制从音频开始 柔和的 默认情况下。使用 muteAudio=false 以包括音频。快速入门:录制窗口
重要:如果没有捕获源,录音将是黑色的!
- 连接:
obs_connection(action: Connect) - 添加源:
obs_source(action: AddWindowCapture, sourceName: "My Capture") - 列出窗口:
obs_source(action: ListWindows, sourceName: "My Capture") - 选择窗口:
obs_source(action: SetWindowCapture, sourceName: "My Capture", windowValue: "...") - 记录:
obs_recording(action: Start)或obs_recording(action: Start, path: "C:/Videos")
或者问问你的人工智能助手: *“在OBS中记录VS代码”*
发展
构建与测试
# Build
dotnet build
# Run unit tests (no OBS required)
dotnet test --filter "Category!=Integration"
# Run integration tests (requires OBS with .env configured)
dotnet test --filter "Category=Integration"项目结构
mcp-server-obs/
├── src/ObsMcp.McpServer/ # .NET 10 MCP Server
│ └── Tools/ # 7 resource-based tools
├── tests/ # Unit & integration tests
├── vscode-extension/ # VS Code extension wrapper
└── .github/workflows/ # Release automation发布
- MCP服务器:推送标签
mcp-v1.0.0→ 打造独立拉链 - VS代码扩展:推送标签
vscode-v1.0.0→ Builds.vsix+发布到Marketplace
许可证
麻省理工学院
