Skip to content
diegosandoval-stackPublic

About

MCP server to control OBS Studio via obs-websocket (scenes, sources, streaming, recording, virtual cam, screenshots).

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

obs-mcp

An MCP server that lets an AI assistant (Claude, etc.) control OBS Studio through obs-websocket v5.

It exposes OBS scenes, sources, streaming, recording, virtual camera and screenshots as MCP tools, plus a raw escape hatch for any obs-websocket request not covered by a dedicated tool.

Requirements

  • OBS Studio 28+ (obs-websocket v5 is built in)
  • Node.js 18+
  • WebSocket server enabled in OBS: Tools → obs-websocket Settings → Enable WebSocket server

Install

npm install
npm run build

Configuration

Set these environment variables if your OBS instance isn't on the default local address, or if it has a password set:

Variable Default Description
OBS_WS_URL ws://127.0.0.1:4455 obs-websocket server URL
OBS_WS_PASSWORD (empty) obs-websocket server password

Usage with an MCP client

Add it to your client's MCP server config, e.g. for Claude Code / Claude Desktop:

{
  "mcpServers": {
    "obs-studio": {
      "command": "node",
      "args": ["C:/path/to/obs-mcp/dist/index.js"],
      "env": {
        "OBS_WS_URL": "ws://127.0.0.1:4455",
        "OBS_WS_PASSWORD": "your-password"
      }
    }
  }
}

Tools

Status

  • obs_get_status — version info, stats (cpu/fps/render times), stream/record/virtual-cam state

Scenes

  • obs_list_scenes — list scenes and the active one
  • obs_set_current_scene — switch the program scene
  • obs_create_scene — create a new empty scene

Scene items

  • obs_list_scene_items — list sources placed in a scene
  • obs_set_scene_item_enabled — show/hide a source inside a scene

Inputs (sources)

  • obs_list_inputs — list input sources, optionally filtered by kind
  • obs_get_input_settings / obs_set_input_settings — read/patch an input's settings
  • obs_set_text_source — shortcut to update a text source's content
  • obs_set_input_mute / obs_toggle_input_mute — mute control
  • obs_set_input_volume — set volume in dB or as a multiplier

Streaming / Recording / Virtual cam

  • obs_start_stream / obs_stop_stream / obs_get_stream_status
  • obs_start_record / obs_stop_record / obs_pause_record / obs_resume_record / obs_get_record_status
  • obs_start_virtualcam / obs_stop_virtualcam

Screenshot

  • obs_take_screenshot — capture a source or scene and save it to disk

Escape hatch

  • obs_raw_request — call any obs-websocket v5 request type directly (filters, transitions, replay buffer, studio mode, profiles, scene collections, etc.)

Development

npm run build   # compile TypeScript to dist/
npm start       # run the compiled server over stdio

License

MIT

About

MCP server to control OBS Studio via obs-websocket (scenes, sources, streaming, recording, virtual cam, screenshots).

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages