OBS Studio MCP server

This MCP server provides tools to control OBS Studio via the OBS WebSocket protocol, allowing you to manage scenes, sources, streaming, and more directly through Claude.

Installation Prerequisites

• Node.js 16 or higher
• OBS Studio 31 or higher
• Claude desktop

Setting Up OBS WebSocket

Before using the MCP server, you need to enable the WebSocket server in OBS:

1. Open OBS Studio
2. Go to Tools > WebSocket Server Settings
3. Enable the WebSocket server
4. Note the password if you've set one

Installing the MCP Server

The easiest way to use the OBS MCP server is to add it to your Claude desktop configuration:

{
  "mcpServers": {
    "obs": {
      "command": "npx",
      "args": ["-y", "obs-mcp@latest"],
      "env": {
        "OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
      }
    }
  }
}

Replace <password_from_obs> with your actual WebSocket password if you've set one.

Configuration Options

You can customize the connection to OBS using environment variables:

• OBS_WEBSOCKET_URL: WebSocket URL (default: ws://localhost:4455)
• OBS_WEBSOCKET_PASSWORD: Password for authenticating with OBS WebSocket

Example of setting the password via environment variable:

export OBS_WEBSOCKET_PASSWORD="your_password_here"

Available Tools

General Tools

• Get OBS version information
• View statistics
• Trigger hotkeys
• Control studio mode

Scene Management

• List all available scenes
• Switch between scenes
• Create and remove scenes

Source Control

• Manage sources and their settings
• Adjust audio levels
• Mute and unmute audio sources

Scene Item Tools

• Position items within scenes
• Control item visibility
• Resize and transform scene items

Streaming and Recording

• Start and stop streaming
• Begin and end recordings
• Control virtual camera

Transition Control

• Set transitions between scenes
• Adjust transition durations
• Manually trigger transitions

Using with Claude

After setting up the MCP server, you can use natural language to ask Claude to control OBS. For example:

• "Switch to my Gaming scene"
• "Start recording"
• "Mute the microphone source"
• "Make the webcam source visible"
• "Stop streaming"

Claude will interpret these commands and use the appropriate OBS MCP tools to control your OBS Studio instance.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "obs" '{"command":"node","args":["<obs-mcp_root>/build/index.js"],"env":{"OBS_WEBSOCKET_PASSWORD":"<password_from_obs>"}}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

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

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

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

3. Restart Claude Desktop for the changes to take effect