mcp -obs

This MCP server exposes an OBS Studio controller through the MCP protocol. It implements a set of tools that let you connect to OBS WebSocket, control recording and streaming, manage scenes and sources, handle audio, take screenshots, and control the virtual camera. You can drive these capabilities from any MCP client or via the included VS Code extension. The available tools map to OBS operations such as connecting to the WebSocket, starting/stopping recordings or streams, switching scenes, adding or configuring sources, muting audio, and taking media actions like screenshots. Typical usage is to connect to the server, then issue tool actions with the appropriate parameters (for example, connect to OBS, add a window capture, then start a recording). The server defaults assume OBS WebSocket is reachable at the host and port you configure via OBS_HOST/OBS_PORT, with OBS_PASSWORD if you’ve set one.

Prerequisites:

• OBS Studio installed (and OBS WebSocket enabled; built-in in OBS Studio 28+).
• .NET 6+ Runtime installed (this server targets .NET 10; ensure the runtime is available on your system).
• A running OBS WebSocket server configured with host, port, and password as needed.

Install steps:

1. Download the MCP server release for OBS from the GitHub Releases page and extract to a preferred location.
2. Ensure you have a DLL path to use in your MCP client configuration. The example below uses the DLL path that ships with the release:
   • Sbroenne.ObsMcp.McpServer.dll
3. Run the MCP server using the suggested command (or configure via an MCP client as shown in the example).
4. In your MCP client, add a server entry that points to the dotnet command and the DLL path, and set OBS connection details via environment variables as needed.

Example run (manually):

• On Windows (command prompt or PowerShell): dotnet Sbroenne.ObsMcp.McpServer.dll

Within an MCP client configuration (example):

{
  "servers": {
    "obs": {
      "command": "dotnet",
      "args": ["C:/Tools/obs-mcp-server/Sbroenne.ObsMcp.McpServer.dll"],
      "env": {
        "OBS_HOST": "localhost",
        "OBS_PORT": "4455",
        "OBS_PASSWORD": ""
      }
    }
  },
  "inputs": [
    {
      "id": "obs_host",
      "type": "promptString",
      "description": "OBS WebSocket host",
      "default": "localhost"
    },
    {
      "id": "obs_port",
      "type": "promptString",
      "description": "OBS WebSocket port",
      "default": "4455"
    },
    {
      "id": "obs_password",
      "type": "promptString",
      "description": "OBS WebSocket password",
      "password": true
    }
  ]
}

Notes and tips:

• Ensure OBS WebSocket is enabled in OBS (Tools -> WebSocket Server Settings) and that the port and password match what you configure in the MCP client.
• The OBS tools may require active network access to the OBS WebSocket; verify firewall rules allow local connections.
• Recording defaults to audio muted; you can adjust this via the obs_recording tool by setting muteAudio to false in the action payload.
• If OBS is running on a different machine, adjust OBS_HOST in the environment variables and ensure the host can reach OBS over the WebSocket port.
• For troubleshooting, review the MCP server logs for connection status and any OBS WebSocket handshake errors.