dcc-mcp-obs

面向 DCC-MCP 生态系统的原生、类型化 OBS Studio 控制。

本产品是一个 OBS 插件外加一个 DCC-MCP sidecar。C++ 插件运行在精确的 OBS 进程内部，负责宿主生命周期和 UI 线程调度，并通过官方 OBS WebSocket 5.x API 注册有界的厂商请求。Python sidecar 通过 MCP、Gateway、Install SOP v1 CLI 以及随附的 Agent skill 暴露这些契约。

OBS WebSocket 是经过认证的传输通道。它不会被用作不受限制的请求后门，本产品也不暴露任何任意脚本或原始 WebSocket 工具。

首个切片

• 精确的原生插件、OBS 版本、PID、实例 ID、就绪状态和事件序列

• 有界的场景发现与当前场景回读

• 针对当前场景或精确命名场景的有界源发现

• 录制状态

• 开始、停止、暂停和恢复录制

• 每次变更后单独的类型化状态回读

• 稳定的脱敏错误、有界的 UI 调度，以及精确实例漂移拒绝

机器可读的能力矩阵跟踪其余产品领域。在类型化契约落地之前，它们有意不作为已交付工具呈现。

Related MCP server: obs-mcp-server

完全控制路线图

• 推流、回放缓冲、虚拟摄像头和输出

• 配置文件、场景集合、有界热键、截图和操作员状态

• 一次性真实 OBS 验收

• 输入、属性、滤镜、音频和媒体

• 场景图、切换、转场和工作室模式

要求

• OBS Studio 28 或更高版本，并启用 OBS WebSocket 5.x

• Python 3.10 或更高版本

• dcc-mcp-core>=0.20.14,<1.0.0

• 与 Windows、macOS 或 Linux 匹配的原生插件包

安装

先安装 Python 控制平面，然后安装随发布提供的原生插件包，其 SHA-256 摘要需从同一发布中获取：

python -m pip install dcc-mcp-obs
dcc-mcp-obs-install install \
  --plugin-archive dcc-mcp-obs-plugin.zip \
  --sha256 <release-sha256>
dcc-mcp-obs-install verify

安装程序会输出一个 Install SOP v1 JSON 对象。--dry-run 在不更改 OBS 插件目录的情况下执行插件包和所有权的预检。参见安装详情。

密码与端点

在操作员自有的环境中配置 OBS WebSocket 密码：

set DCC_MCP_OBS_WEBSOCKET_PASSWORD=your-password

首个版本仅接受 ws://127.0.0.1:<port>，默认端口为 4455。密码绝不会出现在工具结果、回执、公开错误或日志中。DCC_MCP_OBS_WEBSOCKET_URL 仅用于选择其他回环端口。

针对一个精确的 OBS 进程运行 sidecar：

dcc-mcp-obs --host-pid <obs-pid>

Agent 发现

随附的 obs-control skill 包含针对 OBS、Open Broadcaster Software、recording、scene/source inspection、pause、resume、录屏和录制视频的英文与中文发现别名。Agent 在调用本首个切片中的精确八个工具之前，会先搜索并加载该 skill。推流和场景切换仍是路线图能力，而非已交付的原生控制。

OBS 控制以原生插件/WebSocket 为首选。不支持的纯视觉操作，只有在完成精确的 PID 和 HWND 绑定、获取全新快照以及操作后回读之后，才可使用 DCC-MCP ui-control 配合项目自有的 DCC-CUA。不存在通用的 Computer Use 回退方案。

开发

python -m pip install -e ".[dev]"
python -m pytest
python -m ruff check .
python -m ruff format --check .
dcc-mcp-cli lint src/dcc_mcp_obs/skills/obs-control --warnings-as-errors

原生构建使用官方 OBS 插件模板工具链，以及通过 SHA-256 哈希锁定的 OBS 31.1.1 SDK 输入：

cmake --preset windows-x64
cmake --build --preset windows-ci-x64

等效的 CI 构建在 Windows、macOS 和 Linux 上运行。

验证边界

单元测试、模拟协议会话、原生编译、包冒烟测试和 CI 均不能证明已授权/在线的 OBS 宿主。本次初始交付不对真实 OBS 做任何验收声明。一次性在线宿主验收议题仍然是一个独立的发布门禁。

许可证

GPL-2.0-or-later。原生模块链接到 OBS Studio，并随附官方 OBS WebSocket 插件 API 头文件及其原始声明。