OBS MCP Server

by royshil
Verified

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Utilizes Node.js as the runtime environment for the MCP server, with Node.js 16+ being a requirement for operation.

  • Connects to OBS Studio via the WebSocket protocol, providing tools for scene management, source control, streaming/recording control, transitions, and general operations in OBS.

OBS MCP 服务器

OBS Studio 的 MCP 服务器,提供通过 OBS WebSocket 协议控制 OBS 的工具。

特征

  • 连接OBS WebSocket服务器
  • 通过 MCP 工具控制 OBS
  • 提供以下工具:
    • 常规操作
    • 场景管理
    • 源代码控制
    • 场景物品操控
    • 流媒体和录制
    • 过渡

安装

npm install npm run build

用法

  1. 确保 OBS Studio 已启用 WebSocket 服务器(工具 > WebSocket 服务器设置)。请记下 WebSocket 服务器的密码。
  2. 在环境变量中设置 WebSocket 密码(如果需要):
export OBS_WEBSOCKET_PASSWORD="your_password_here"
  1. 运行OBS MCP服务器,查看是否能够建立并连接:
npm run build npm run start
  1. 使用 MCP 服务器设置来配置您的 Claude 桌面:
{ "mcpServers": { "obs": { "command": "node", "args": [ "<obs-mcp_root>/build/index.js" ], "env": { "OBS_WEBSOCKET_PASSWORD": "<password_from_obs>" } } } }
  1. 使用 Claude 来控制你的 OBS!

可用工具

该服务器提供按类别组织的工具:

  • 常规工具:版本信息、统计数据、热键、工作室模式
  • 场景工具:列出场景、切换场景、创建/删除场景
  • 源工具:管理源、设置、音频级别、静音/取消静音
  • 场景项目工具:管理场景中的项目(位置、可见性等)
  • 流媒体工具:开始/停止流媒体、录制、虚拟摄像头
  • 过渡工具:设置过渡、持续时间、触发过渡

环境变量

  • OBS_WEBSOCKET_URL :WebSocket URL(默认值:ws://localhost:4455)
  • OBS_WEBSOCKET_PASSWORD :使用 OBS WebSocket 进行身份验证的密码(如果需要)

要求

  • Node.js 16+
  • 已启用 WebSocket 服务器的 OBS Studio 31+
  • 克劳德桌面

执照

有关详细信息,请参阅LICENSE文件。

-
security - not tested
A
license - permissive license
-
quality - not tested

该服务器提供通过 OBS WebSocket 协议远程控制 OBS Studio 的工具,从而可以通过 MCP 客户端界面管理场景、源、流媒体和录制。

  1. Features
    1. Installation
      1. Usage
        1. Available Tools
          1. Environment Variables
            1. Requirements
              1. License
                ID: ss2j6yvx7q