Obs MCP

🚀 OBS MCP Server

An MCP server for OBS Studio, providing tools to control OBS via the OBS WebSocket protocol.

🚀 Quick Start

This OBS MCP server offers a convenient way to control OBS Studio through the OBS WebSocket protocol. Follow the steps below to get started.

✨ Features

• Connect to the OBS WebSocket server.
• Control OBS using MCP tools.
• Provide the following tools:
  • General operations
  • Scene management
  • Source control
  • Scene item operations
  • Streaming and recording
  • Transitions

📦 Installation

npm install
npm run build

💻 Usage Examples

Basic Usage

1. Ensure that OBS Studio is running and the WebSocket server is enabled (Tools > WebSocket Server Settings). Note down the password.
2. Set the WebSocket password as an environment variable (if required):

export OBS_WEBSOCKET_PASSWORD="your_password_here"

3. Run the OBS MCP server to ensure it builds and connects properly:

npm run build
npm run start

4. Configure your Claude desktop to use the MCP server settings:

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

5. Control OBS using Claude!

Tools Provided

The server provides the following tools categorized as follows:

• General Tools: Version information, statistics, shortcuts, studio mode
• Scene Tools: List scenes, switch scenes, create/delete scenes
• Source Tools: Manage sources, settings, volume levels, mute/unmute
• Scene Item Tools: Manage items in scenes (position, visibility, etc.)
• Streaming Tools: Start/stop streaming, recording, virtual camera
• Transition Tools: Set transitions, duration, trigger transitions

📚 Documentation

Environment Variables

• OBS_WEBSOCKET_URL: WebSocket URL (Default: ws://localhost:4455)
• OBS_WEBSOCKET_PASSWORD: OBS WebSocket password for authentication (if required)

Requirements

• Node.js 16+
• OBS Studio 31+ with the WebSocket server enabled
• Claude desktop

📄 License

For detailed information, please refer to the LICENSE file.