Obs MCP

🚀 OBS MCP 服務器

OBS MCP 服務器是一款專為 OBS Studio 打造的工具，藉助 OBS WebSocket 協議，能實現對 OBS 的便捷控制。

🚀 快速開始

OBS MCP 服務器可通過 OBS WebSocket 協議控制 OBS Studio。以下是使用前的準備步驟：

1. 確保 OBS Studio 已運行並啟用了 WebSocket 服務器（工具 > WebSocket 服務器設置），並記下密碼。
2. 設置 WebSocket 密碼為環境變量（如果需要）：

export OBS_WEBSOCKET_PASSWORD="your_password_here"

3. 運行 OBS MCP 服務器以確保其正常構建和連接：

npm install
npm run build
npm run start

4. 配置您的 Claude 桌面以使用 MCP 服務器設置：

{
  "mcpServers": {
    "obs": {
      "command": "node",
      "args": [
        "<obs-mcp_root>/build/index.js"
      ],
      "env": {
        "OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
      }
    }
  }
}

5. 使用 Claude 控制 OBS！

✨ 主要特性

• 可連接到 OBS WebSocket 服務器。
• 藉助 MCP 工具實現對 OBS 的控制。
• 提供豐富的工具類別，涵蓋通用操作、場景管理、源控制、場景項目操作、流媒體和錄製以及轉場等方面。

📦 安裝指南

npm install
npm run build

💻 使用示例

基礎用法

# 安裝依賴
npm install
# 構建項目
npm run build
# 啟動服務器
npm run start

高級用法

{
  "mcpServers": {
    "obs": {
      "command": "node",
      "args": [
        "<obs-mcp_root>/build/index.js"
      ],
      "env": {
        "OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
      }
    }
  }
}

此配置可用於在 Claude 桌面中使用 MCP 服務器來控制 OBS。

📚 詳細文檔

提供的工具

服務器按類別提供了以下工具：

• 通用工具：版本信息、統計信息、快捷鍵、工作室模式
• 場景工具：列出場景、切換場景、創建/刪除場景
• 源工具：管理源、設置、音量電平、靜音/取消靜音
• 場景項目工具：管理場景中的項目（位置、可見性等）
• 流媒體工具：啟動/停止流媒體、錄製、虛擬攝像頭
• 轉場工具：設置轉場、持續時間、觸發轉場

環境變量

要求

• Node.js 16+
• OBS Studio 31+，且已啟用 WebSocket 服務器
• Claude 桌面

📄 許可證

有關詳細信息，請參閱 LICENSE 文件。