OBS Studio MCP server

This OBS MCP server provides tools to control OBS Studio through the WebSocket protocol, allowing you to manage scenes, sources, streaming, recording, and other OBS functionality programmatically through Claude.

Installation

To install the OBS MCP server:

npm install
npm run build

Setup

Before using the server, you need to configure OBS Studio:

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

Environment Configuration

You can configure the server connection using environment variables:

# Set WebSocket password (if required by your OBS WebSocket server)
export OBS_WEBSOCKET_PASSWORD="your_password_here"

Additional environment variables:

• OBS_WEBSOCKET_URL: WebSocket URL (default: ws://localhost:4455)

Running the Server

Start the OBS MCP server:

npm run build
npm run start

Configuring Claude Desktop

To enable Claude to control OBS, you need to provision your Claude desktop with the MCP server settings:

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

Replace <obs-mcp_root> with the actual path to your OBS MCP server directory and <password_from_obs> with your OBS WebSocket password.

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 new scenes
• Remove existing scenes

Source Control

• Manage sources in your scenes
• Adjust source settings
• Control audio levels
• Mute and unmute audio sources

Scene Item Manipulation

• Position items within scenes
• Change visibility of scene items
• Resize and rotate scene elements

Streaming and Recording

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

Transitions

• Set transition types
• Adjust transition durations
• Manually trigger transitions

Requirements

• Node.js 16 or newer
• OBS Studio 31+ with WebSocket server enabled
• Claude desktop application

How to add this MCP server to 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 > MCP and click "Add new global MCP server".

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

{
    "mcpServers": {
        "cursor-rules-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "cursor-rules-mcp"
            ]
        }
    }
}

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 explictly ask the agent to use the tool by mentioning the tool name and describing what the function does.