Skip to main content
Glama

OBS MCP Server

An MCP server for OBS Studio that provides tools, resources, structured prompts, multimodal vision inspection, atomic batch macros, event capturing, and safety guardrails to monitor and control OBS via the OBS WebSocket protocol. Available in both TypeScript and Python.

Features

  • Connect to OBS WebSocket server with auto-reconnection and SHA-256 authentication

  • Atomic Batch Macros (RequestBatch OpCode 8/9): Execute multi-step broadcast macros atomically in a single network round-trip with haltOnFailure and execution type options (SerialRealtime, SerialFrame, Parallel)

  • Real-Time Event Ring Buffer: Capture incoming OBS WebSocket events (OpCode 5) in a 100-event circular buffer; exposed via obs-get-recent-events and obs://events/recent

  • Native Multimodal ImageContent: Vision model screenshot inspection returning native { type: "image", data: base64, mimeType: "image/png" } blocks

  • Safety Guardrails: Production protection with OBS_READ_ONLY=true and OBS_PROTECT_DESTRUCTIVE=true

  • Read-Only MCP Resources: Instant consolidated state snapshots (obs://state/summary, obs://scenes/current, obs://audio/mixer, obs://events/recent) to eliminate multi-call round trips

  • Structured MCP Prompts: Pre-flight checklists and workflow templates (go-live-checklist, recording-setup, emergency-brb, audio-check)

  • Dynamic Tool Filtering: Load only the modules you need to save LLM context window tokens

  • Consolidated Compound Tools: Optional compound tool mode (--compound) reducing 156 tools to 12 unified tools with action enums

  • Full Engine Parity: Both TypeScript (build/index.js) and Python FastMCP (py_src/) support batch requests, circular event buffering, compound tools, and safety guardrails

  • Comprehensive coverage of the OBS WebSocket v5 Protocol (100% official protocol requests implemented)


Related MCP server: OBS MCP

Atomic Request Batching (OpCode 8 RequestBatch)

Execute multi-step broadcast macros atomically in a single network call using obs-execute-batch or obs_manage_general (action: execute_batch):

{
  "name": "obs-execute-batch",
  "arguments": {
    "executionType": "SerialRealtime",
    "haltOnFailure": true,
    "requests": [
      {
        "requestType": "SetCurrentProgramScene",
        "requestData": { "sceneName": "Intro" }
      },
      {
        "requestType": "SetInputMute",
        "requestData": { "inputName": "Mic/Aux", "inputMuted": false }
      },
      {
        "requestType": "Sleep",
        "requestData": { "sleepMillis": 500 }
      },
      {
        "requestType": "StartRecord"
      }
    ]
  }
}
  • Execution Types:

    • SerialRealtime (0): Executes sequentially in real time (respects Sleep pauses).

    • SerialFrame (1): Executes sequentially, advancing one request per frame tick.

    • Parallel (2): Executes requests simultaneously.

  • Safety Integration: Every subrequest in the batch is pre-validated against active safety policies (OBS_READ_ONLY and OBS_PROTECT_DESTRUCTIVE) before transmission.


Real-Time Event Subscription & Ring Buffer

OBSWebSocketClient automatically subscribes to all OBS WebSocket events (eventSubscriptions: All). Incoming events (OpCode 5) are stored in an in-memory 100-event circular ring buffer with millisecond-precision timestamps:

  • Tool: obs-get-recent-events (with limit and eventType filter)

  • MCP Resource: obs://events/recent (returns the full real-time snapshot)

Enables LLMs and agents to inspect recent asynchronous OBS activity without polling:

  • User manually switched scenes or muted audio in OBS GUI

  • Stream dropped frames or network reconnection alerts

  • Media source playback completed or loop restarted

  • Recording file split or output state changed


Native Multimodal Screenshot Inspection

Both obs-get-source-screenshot and obs_manage_sources (action: get_screenshot) return native MCP ImageContent objects alongside a concise text summary block. Vision models (Claude 3.5 Sonnet, Claude 3.7 Sonnet, Gemini 2.0/3.0, GPT-4o) can visually analyze scene layout, camera framing, lower-third overlays, and black screen detection directly.

  • Data URI Stripping: Automatically extracts pure Base64 and proper MIME types (image/png, image/jpeg).

  • Context-Friendly Default Resolution: Defaults to imageWidth: 960 (and default imageCompressionQuality: 80) to balance visual clarity with context window token limits.

  • Auto Active Scene Target: If no sourceName or sourceUuid is provided, it automatically captures the active Program scene.

// Example: Simply call without parameters to inspect current program scene
{
  "name": "obs-get-source-screenshot",
  "arguments": {}
}

Safety Guardrails (Production Protection)

To prevent accidental deletions or unintended live broadcasts, two layers of safety middleware can be enabled:

1. Read-Only Mode (OBS_READ_ONLY=true or --read-only)

Blocks all state-modifying requests (e.g., scene switches, volume changes, creating/removing items, recording, streaming). Only inspection and status requests (Get*) are permitted:

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

2. Destructive & Live-Broadcast Guardrail (OBS_PROTECT_DESTRUCTIVE=true or --protect-destructive)

Protects critical operations:

  • StartStream

  • StopStream

  • RemoveScene

  • RemoveInput

  • RemoveProfile

  • SetCurrentSceneCollection

When enabled, these actions will be blocked unless:

  • The caller explicitly supplies "confirm": true in the tool arguments, OR

  • OBS_ALLOW_LIVE_STREAM=true is set in the environment (applies to streaming actions).

Example:

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

MCP Resources (Consolidated Snapshots)

Read-only resources provide immediate, comprehensive context to the AI assistant without requiring multiple tool calls:

Resource URI

Description

Contents

obs://state/summary

Live broadcast & system status

Connection, OBS version, active program & preview scenes, streaming/recording status (timecode, bytes, duration), virtual cam, replay buffer, and CPU/FPS stats

obs://scenes/current

Active scenes & visual hierarchy

Program scene, preview scene, available scenes, and complete scene item list with transform matrices, visibility, lock states, and blend modes

obs://audio/mixer

Complete audio calibration

All inputs, volume levels (dB and multiplier), mute states, sync offsets, audio monitor types, and audio track routing (tracks 1-6)

obs://events/recent

Real-time event activity buffer

Last 100 OBS events captured in real-time with eventType, eventData, and ISO 8601 timestamps


MCP Prompts (Workflow Templates)

Structured prompts guide the AI assistant through standardized operational procedures:

Prompt

Description

Key Workflow

go-live-checklist

Pre-stream sanity verification

Audits connection, stage readiness, audio levels, and stream output settings, and asks for final confirmation before starting broadcast

recording-setup

Local video recording setup

Validates record folder, canvas/output video resolutions, FPS, and multi-track audio isolation (e.g. separating mic vs desktop audio)

emergency-brb

Privacy lockdown & failsafe

Instantly mutes all microphone/auxiliary inputs, switches to a safe BRB scene, and pauses recording / adds chapter marker

audio-check

Comprehensive audio audit

Analyzes volume levels against broadcast standards (-12dB to -6dB voice, -24dB to -18dB background), audits mute states and lip-sync delays


Solving "Context Bloat"

Registering 156 separate tools can consume a large amount of an LLM's context window. You can optimize this using either Dynamic Module Filtering or Compound Tools Mode:

Option 1: Dynamic Module Filtering (Selective Loading)

Load only the specific categories you need using the --categories CLI argument or the OBS_MCP_MODULES environment variable:

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

Option 2: Compound Tools Mode (Maximum Context Efficiency)

In compound mode, operations are grouped into 12 consolidated tools (e.g., obs_manage_recording, obs_manage_scenes, obs_manage_inputs, obs_manage_general) with action enums:

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

Python Engine (py_src/)

A native Python server is included in py_src/ with complete feature parity:

  • Run with compound mode: python py_src/obs-mcp.py --compound

  • Run with safety guardrails: python py_src/obs-mcp.py --protect-destructive

  • Supports batch requests (send_request_batch), event circular ring buffer, and FastMCP resources (obs://events/recent).


Usage

  1. Make sure OBS Studio is running with WebSocket server enabled (Tools > WebSocket Server Settings).

  2. Set your WebSocket password in your MCP client config or environment.

  3. Configure your MCP client (Claude Desktop, Cursor, etc.):

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

Environment Variables & CLI Flags

Setting

Flag / Variable

Description

WebSocket URL

OBS_WEBSOCKET_URL

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

Password

OBS_WEBSOCKET_PASSWORD

Password for OBS WebSocket authentication

Read-Only

--read-only, OBS_READ_ONLY

Prohibits all state modifications

Protect Destructive

--protect-destructive, OBS_PROTECT_DESTRUCTIVE

Blocks destructive/stream actions unless confirm: true is passed

Allow Live Stream

--allow-live-stream, OBS_ALLOW_LIVE_STREAM

Permits stream start/stop without confirmation

Module Filter

--categories=<list>, OBS_MCP_MODULES

Comma-separated list of categories to load

Compound Mode

--compound, OBS_MCP_MODE=compound

Enables consolidated compound tools

Help

--help, -h

Prints command line usage and options


License & Attribution

This project is licensed under the GNU General Public License v2.0 (GPL-2.0). See the LICENSE file for the complete license terms and notices.

Upstream Attribution & Acknowledgments

This project is an enhanced and architecturally expanded fork of obs-mcp, originally created by Roy Shilkrot. We gratefully acknowledge Roy Shilkrot and contributors for creating the initial Model Context Protocol bridge for OBS Studio.

Key Enhancements Added in this Version

  • 100% OBS WebSocket v5 Protocol Parity: Closed the protocol gap, expanding granular tools from 127 to 156 requests (including scene item blend modes, group hierarchies, transform matrices, and locking controls).

  • Dynamic Tool Filtering: Solves LLM context bloat via selective loading (--categories / OBS_MCP_MODULES).

  • Compound Tools Mode: 12 consolidated tools (--compound) using action enums to optimize token usage.

  • Native Multimodal ImageContent: Returns native MCP image content blocks for live vision model scene inspection.

  • Production Safety Guardrails: Prohibits accidental deletions or unintended live streams via OBS_READ_ONLY and OBS_PROTECT_DESTRUCTIVE.

  • Consolidated MCP Resources & Workflow Prompts: Read-only snapshots (obs://state/summary, obs://scenes/current, obs://audio/mixer, obs://events/recent) and standardized operational prompts.

  • Atomic Batch Macros: Full support for OBS WebSocket v5 native RequestBatch (OpCode 8/9) with haltOnFailure and execution strategies (SerialRealtime, SerialFrame, Parallel).

  • Real-Time Event Ring Buffer: Circular 100-event buffer capturing live OBS events with timestamps.

  • Complete Python Engine Parity: Both TypeScript (build/index.js) and Python FastMCP (py_src/) engines share complete feature parity.

Available Tools

158 tools
obs-broadcast-custom-eventC

Broadcasts a CustomEvent to all WebSocket clients

Inputs: eventData (required).

obs-call-vendor-requestC

Call a request registered to a vendor

Inputs: vendorName (required), requestType (required), requestData.

obs-create-inputC

Creates a new input, adding it as a scene item to the specified scene

Inputs: inputKind (required), inputName (required), sceneName (required), inputSettings, +1 more.

obs-create-profileC

Creates a new profile, switching to it in the process

Inputs: profileName (required).

obs-create-record-chapterB

Adds a new chapter marker to the file currently being recorded

Inputs: chapterName.

obs-create-sceneC

Create a new scene in OBS

Inputs: sceneName (required).

obs-create-scene-collectionC

Creates a new scene collection, switching to it in the process

Inputs: sceneCollectionName (required).

obs-create-scene-itemC

Create a scene item for a source in a scene

Inputs: sceneName (required), sourceName (required), enabled.

obs-create-source-filterC

Creates a new filter, adding it to the specified source

Inputs: filterKind (required), filterName (required), sourceName (required), filterSettings.

obs-duplicate-scene-itemC

Duplicates a scene item, copying all transform and crop info

Inputs: sceneItemId (required), sceneName, sceneUuid, destinationSceneName, +1 more.

obs-execute-batchC

Executes multiple OBS WebSocket requests atomically as a batch (OpCode 8 RequestBatch)

Inputs: requests (required), confirm, executionType, haltOnFailure.

obs-get-current-sceneB

Get the current active scene in OBS

Inputs: no named parameters.

obs-get-current-transitionB

Get the name of the currently active transition

Inputs: no named parameters.

obs-get-filter-default-settingsC

Gets the default settings for a filter kind

Inputs: filterKind (required).

obs-get-filter-kind-listB

Gets an array of all available source filter kinds

Inputs: no named parameters.

obs-get-group-listB

Gets an array of all groups in OBS

Inputs: no named parameters.

obs-get-group-scene-itemsC

Get a list of all scene items in a group

Inputs: sceneName, sceneUuid.

obs-get-hotkey-listB

Gets an array of all hotkey names in OBS

Inputs: no named parameters.

obs-get-input-audio-balanceC

Gets the audio balance of an input

Inputs: inputName (required).

obs-get-input-audio-monitor-typeB

Gets the audio monitor type of an input

Inputs: inputName (required).

obs-get-input-audio-sync-offsetC

Gets the audio sync offset of an input

Inputs: inputName (required).

obs-get-input-audio-tracksB

Gets the enable state of all audio tracks of an input

Inputs: inputName, inputUuid.

obs-get-input-default-settingsC

Gets the default settings for an input kind

Inputs: inputKind (required).

obs-get-input-deinterlace-field-orderA

Gets the deinterlace field order of an input (restricted to async inputs only)

Inputs: inputName, inputUuid.

obs-get-input-deinterlace-modeA

Gets the deinterlace mode of an input (restricted to async inputs only)

Inputs: inputName, inputUuid.

obs-get-input-kind-listB

Gets an array of all available input kinds in OBS

Inputs: unversioned.

obs-get-input-listC

Gets an array of all inputs in OBS

Inputs: inputKind.

obs-get-input-muteB

Gets the audio mute state of an input

Inputs: inputName (required).

obs-get-input-properties-list-property-itemsC

Gets the items of a list property from an input's properties (e.g. display capture available displays)

Inputs: propertyName (required), inputName, inputUuid.

obs-get-input-settingsC

Gets the settings of an input

Inputs: inputName (required).

obs-get-input-volumeC

Gets the current volume setting of an input

Inputs: inputName (required).

obs-get-last-replay-buffer-replayB

Gets the filename of the last replay buffer save file

Inputs: no named parameters.

obs-get-media-input-statusC

Gets the status of a media input

Inputs: inputName (required).

obs-get-monitor-listB

Gets a list of connected monitors and information about them

Inputs: no named parameters.

obs-get-output-listB

Gets the list of available outputs

Inputs: no named parameters.

obs-get-output-settingsC

Gets the settings of an output

Inputs: outputName (required).

obs-get-output-statusC

Gets the status of an output

Inputs: outputName (required).

obs-get-persistent-dataC

Gets the value of a slot from the selected persistent data realm

Inputs: realm (required), slotName (required).

obs-get-preview-sceneA

Get the current preview scene in OBS Studio Mode

Inputs: no named parameters.

obs-get-profile-listB

Gets an array of all profiles

Inputs: no named parameters.

obs-get-profile-parameterB

Gets a parameter from the current profile's configuration

Inputs: parameterName (required), parameterCategory (required).

obs-get-recent-eventsC

Get recent OBS events captured in the real-time circular ring buffer

Inputs: limit, eventType.

obs-get-record-directoryB

Gets the current directory that the record output is set to

Inputs: no named parameters.

obs-get-record-statusC

Gets the status of the record output

Inputs: no named parameters.

obs-get-replay-buffer-statusB

Gets the status of the replay buffer output

Inputs: no named parameters.

obs-get-scene-collection-listB

Gets an array of all scene collections

Inputs: no named parameters.

obs-get-scene-item-blend-modeC

Gets the blend mode of a scene item

Inputs: sceneItemId (required), sceneName, sceneUuid.

obs-get-scene-item-enabledB

Gets the enable/visibility state of a scene item

Inputs: sceneItemId (required), sceneName, sceneUuid.

obs-get-scene-item-idB

Get the ID of a scene item by its source name

Inputs: sceneName (required), sourceName (required).

obs-get-scene-item-indexB

Gets the index position of a scene item in a scene (0 is bottom of the source list)

Inputs: sceneItemId (required), sceneName, sceneUuid.

obs-get-scene-item-lockedC

Gets the lock state of a scene item

Inputs: sceneItemId (required), sceneName, sceneUuid.

obs-get-scene-item-private-settingsB

Gets the private settings of a scene item

Inputs: sceneItemId (required), sceneName, sceneUuid.

obs-get-scene-itemsC

Get a list of all scene items in a scene

Inputs: sceneName (required).

obs-get-scene-item-sourceC

Gets the source associated with a scene item

Inputs: sceneItemId (required), sceneName, sceneUuid.

obs-get-scene-item-transformC

Get the position, rotation, scale, or crop of a scene item

Inputs: sceneName (required), sceneItemId (required).

obs-get-scene-listB

Get a list of scenes in OBS

Inputs: no named parameters.

obs-get-scene-transition-overrideC

Gets the scene transition overridden for a scene

Inputs: sceneName, sceneUuid.

obs-get-source-activeB

Gets the active and show state of a source

Inputs: sourceName, sourceUuid.

obs-get-source-filterC

Gets the info for a specific source filter

Inputs: filterName (required), sourceName (required).

obs-get-source-filter-listB

Gets an array of all of a source's filters

Inputs: sourceName (required).

obs-get-source-private-settingsC

Gets the private settings of a source

Inputs: sourceName, sourceUuid.

obs-get-source-screenshotB

Gets a screenshot of a source or current scene as native MCP multimodal ImageContent for vision models

Inputs: imageWidth, sourceName, sourceUuid, imageFormat, +2 more.

obs-get-special-inputsB

Gets the names of all special inputs

Inputs: no named parameters.

obs-get-statsB

Gets statistics about OBS, obs-websocket, and the current session

Inputs: no named parameters.

obs-get-statusA

Get the current status of the OBS MCP server and OBS connection

Inputs: no named parameters.

obs-get-stream-service-settingsB

Gets the current stream service settings

Inputs: no named parameters.

obs-get-stream-statusB

Get the current streaming status

Inputs: no named parameters.

obs-get-studio-modeB

Gets whether studio mode is enabled

Inputs: no named parameters.

obs-get-transition-cursorA

Gets the cursor position of the current scene transition (0.0 to 1.0, 1.0 when inactive)

Inputs: no named parameters.

obs-get-transition-durationA

Get the duration of the current transition in milliseconds

Inputs: no named parameters.

obs-get-transition-kindB

Get the kind/type of the current transition

Inputs: no named parameters.

obs-get-transition-kind-listB

Gets an array of all available transition kinds in OBS

Inputs: no named parameters.

obs-get-transition-listB

Get a list of available transitions in OBS

Inputs: no named parameters.

obs-get-transition-settingsB

Get the settings of the current transition

Inputs: no named parameters.

obs-get-versionB

Get OBS Studio version information

Inputs: no named parameters.

obs-get-video-settingsB

Gets the current video settings

Inputs: no named parameters.

obs-get-virtual-cam-statusB

Gets the status of the virtualcam output

Inputs: no named parameters.

obs-offset-media-input-cursorC

Offsets the current cursor position of a media input

Inputs: inputName (required), mediaCursorOffset (required).

obs-open-input-filtersC

Opens the filters dialog of an input

Inputs: inputName, inputUuid.

obs-open-input-interactC

Opens the interact dialog of an input

Inputs: inputName, inputUuid.

obs-open-input-propertiesC

Opens the properties dialog of an input

Inputs: inputName, inputUuid.

obs-open-source-projectorC

Opens a projector for a source

Inputs: sourceName, sourceUuid, monitorIndex, projectorGeometry.

obs-open-video-mix-projectorC

Opens a projector for a specific output video mix

Inputs: videoMixType (required), monitorIndex, projectorGeometry.

obs-pause-recordC

Pauses the record output

Inputs: no named parameters.

obs-press-input-properties-buttonC

Presses a button in the properties of an input (e.g. 'refreshnocache' for browser sources)

Inputs: propertyName (required), inputName, inputUuid.

obs-remove-inputC

Removes an existing input

Inputs: inputName (required), confirm.

obs-remove-profileB

Removes a profile. If the current profile is chosen, it will change to a different profile first

Inputs: profileName (required), confirm.

obs-remove-sceneC

Remove a scene from OBS

Inputs: sceneName (required), confirm.

obs-remove-scene-itemC

Remove a scene item from a scene

Inputs: sceneName (required), sceneItemId (required).

obs-remove-source-filterC

Removes a filter from a source

Inputs: filterName (required), sourceName (required).

obs-resume-recordC

Resumes the record output

Inputs: no named parameters.

obs-save-replay-bufferB

Saves the contents of the replay buffer output

Inputs: no named parameters.

obs-save-source-screenshotB

Saves a screenshot of a source to the filesystem

Inputs: imageFormat (required), imageFilePath (required), imageWidth, sourceName, +3 more.

obs-send-stream-captionC

Sends CEA-608 caption text over the stream output

Inputs: captionText (required).

obs-set-current-profileC

Switches to a profile

Inputs: profileName (required).

obs-set-current-sceneC

Set the current active scene in OBS

Inputs: sceneName (required).

obs-set-current-scene-collectionC

Switches to a scene collection

Inputs: sceneCollectionName (required), confirm.

obs-set-current-transitionC

Set the current transition in OBS

Inputs: transitionName (required).

obs-set-input-audio-balanceC

Sets the audio balance of an input

Inputs: inputName (required), inputAudioBalance (required).

obs-set-input-audio-monitor-typeC

Sets the audio monitor type of an input

Inputs: inputName (required), monitorType (required).

obs-set-input-audio-sync-offsetC

Sets the audio sync offset of an input

Inputs: inputName (required), inputAudioSyncOffset (required).

obs-set-input-audio-tracksB

Sets the enable state of audio tracks of an input

Inputs: inputAudioTracks (required), inputName, inputUuid.

obs-set-input-deinterlace-field-orderB

Sets the deinterlace field order of an input (restricted to async inputs only)

Inputs: fieldOrder (required), inputName, inputUuid.

obs-set-input-deinterlace-modeB

Sets the deinterlace mode of an input (restricted to async inputs only)

Inputs: deinterlaceMode (required), inputName, inputUuid.

obs-set-input-muteC

Sets the audio mute state of an input

Inputs: inputName (required), inputMuted (required).

obs-set-input-nameC

Sets the name of an input (rename)

Inputs: inputName (required), newInputName (required).

obs-set-input-settingsC

Sets the settings of an input

Inputs: inputName (required), inputSettings (required), overlay.

obs-set-input-volumeC

Sets the volume setting of an input

Inputs: inputName (required), inputVolumeDb, inputVolumeMul.

obs-set-media-input-cursorC

Sets the cursor position of a media input

Inputs: inputName (required), mediaCursor (required).

obs-set-output-settingsC

Sets the settings of an output

Inputs: outputName (required), outputSettings (required).

obs-set-persistent-dataC

Sets the value of a slot from the selected persistent data realm

Inputs: realm (required), slotName (required), slotValue.

obs-set-preview-sceneB

Set the current preview scene in OBS Studio Mode

Inputs: sceneName (required).

obs-set-profile-parameterC

Sets the value of a parameter in the current profile's configuration

Inputs: parameterName (required), parameterValue (required), parameterCategory (required).

obs-set-record-directoryC

Sets the current directory that the record output writes files to

Inputs: recordDirectory (required).

obs-set-scene-item-blend-modeC

Sets the blend mode of a scene item (OBS_BLEND_NORMAL, OBS_BLEND_ADDITIVE, OBS_BLEND_SUBTRACT, OBS_BLEND_SCREEN, OBS_BLEND_MULTIPLY, OBS_BLEND_LIGHTEN, OBS_BLEND_DARKEN)

Inputs: blendMode (required), sceneItemId (required), sceneName, sceneUuid.

obs-set-scene-item-enabledC

Show or hide a scene item

Inputs: enabled (required), sceneName (required), sceneItemId (required).

obs-set-scene-item-indexA

Sets the index position of a scene item in a scene (0 is bottom of the source list)

Inputs: sceneItemId (required), sceneItemIndex (required), sceneName, sceneUuid.

obs-set-scene-item-lockedC

Sets the lock state of a scene item

Inputs: locked (required), sceneItemId (required), sceneName, sceneUuid.

obs-set-scene-item-private-settingsC

Sets the private settings of a scene item

Inputs: sceneItemId (required), sceneItemSettings (required), overlay, sceneName, +1 more.

obs-set-scene-item-transformC

Set the position, rotation, scale, or crop of a scene item

Inputs: sceneName (required), sceneItemId (required), scaleX, scaleY, +7 more.

obs-set-scene-nameB

Sets the name of a scene (rename)

Inputs: newSceneName (required), sceneName, sceneUuid.

obs-set-scene-transition-overrideC

Sets the scene transition overridden for a scene

Inputs: sceneName, sceneUuid, transitionName, transitionDuration.

obs-set-source-filter-enabledC

Sets the enable state of a source filter

Inputs: filterName (required), sourceName (required), filterEnabled (required).

obs-set-source-filter-indexC

Sets the index position of a filter on a source

Inputs: filterName (required), sourceName (required), filterIndex (required).

obs-set-source-filter-nameC

Sets the name of a source filter (rename)

Inputs: filterName (required), sourceName (required), newFilterName (required).

obs-set-source-filter-settingsC

Sets the settings of a source filter

Inputs: filterName (required), sourceName (required), filterSettings (required), overlay.

obs-set-source-private-settingsC

Sets the private settings of a source

Inputs: sourceSettings (required), overlay, sourceName, sourceUuid.

obs-set-stream-service-settingsC

Sets the current stream service settings

Inputs: streamServiceType (required), streamServiceSettings (required).

obs-set-studio-modeC

Enables or disables studio mode

Inputs: studioModeEnabled (required).

obs-set-tbar-positionC

Sets the position of the TBar

Inputs: position (required), release.

obs-set-transition-durationC

Set the duration of the current transition in milliseconds

Inputs: duration (required).

obs-set-transition-settingsC

Set the settings of the current transition

Inputs: transitionSettings (required).

obs-set-video-settingsC

Sets the current video settings

Inputs: baseWidth, baseHeight, outputWidth, fpsNumerator, +2 more.

obs-sleepB

Sleeps for a time duration or number of frames

Inputs: sleepFrames, sleepMillis.

obs-split-record-fileB

Splits the current file being recorded into a new file

Inputs: no named parameters.

obs-start-outputD

Starts an output

Inputs: outputName (required).

obs-start-recordD

Starts the record output

Inputs: no named parameters.

obs-start-replay-bufferC

Starts the replay buffer output

Inputs: no named parameters.

obs-start-streamC

Start streaming in OBS

Inputs: confirm.

obs-start-virtual-camC

Starts the virtualcam output

Inputs: no named parameters.

obs-stop-outputC

Stops an output

Inputs: outputName (required).

obs-stop-recordC

Stops the record output

Inputs: no named parameters.

obs-stop-replay-bufferB

Stops the replay buffer output

Inputs: no named parameters.

obs-stop-streamC

Stop streaming in OBS

Inputs: confirm.

obs-stop-virtual-camB

Stops the virtualcam output

Inputs: no named parameters.

obs-test-connectionB

Test the connection to OBS WebSocket

Inputs: no named parameters.

obs-toggle-input-muteC

Toggles the audio mute state of an input

Inputs: inputName (required).

obs-toggle-outputC

Toggles the status of an output

Inputs: outputName (required).

obs-toggle-recordC

Toggles the status of the record output

Inputs: no named parameters.

obs-toggle-record-pauseB

Toggles pause on the record output

Inputs: no named parameters.

obs-toggle-replay-bufferB

Toggles the state of the replay buffer output

Inputs: no named parameters.

obs-toggle-streamC

Toggle the streaming state in OBS

Inputs: confirm.

obs-toggle-virtual-camB

Toggles the state of the virtualcam output

Inputs: no named parameters.

obs-trigger-hotkey-by-key-sequenceC

Triggers a hotkey using a sequence of keys

Inputs: keyId, keyModifiers.

obs-trigger-hotkey-by-nameC

Triggers a hotkey using its name

Inputs: hotkeyName (required), contextName.

obs-trigger-media-input-actionC

Triggers an action on a media input

Inputs: inputName (required), mediaAction (required).

obs-trigger-studio-transitionB

Trigger a transition from preview to program scene in Studio Mode

Inputs: no named parameters.

obs-trigger-transitionB

Trigger a scene transition in OBS (Studio Mode must be enabled)

Inputs: no named parameters.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    C2.8/5.0

    Scored across 158 tools

    Disambiguation3/5

    Most tools map one-to-one onto distinct obs-websocket requests with explicit resource+action names, so the vast majority are easy to tell apart. However there are real overlaps: obs-trigger-transition vs obs-trigger-studio-transition (both described as studio-mode transitions), obs-start-stream/stop-stream vs obs-start-output/stop-output, obs-toggle-record vs start/stop/pause-record, and state getters like obs-get-source-active vs obs-get-scene-item-enabled. At 158 tools these redundancies make misselection a genuine risk.

    Naming Consistency5/5

    Nearly every tool follows the same obs-{verb}-{noun} kebab-case pattern (get-/set-/toggle-/start-/stop-/create-/remove-/trigger-). Only trivial outliers like obs-sleep and obs-open-input-properties deviate, and they remain readable and unambiguous.

    Tool Count2/5

    158 tools is an order of magnitude beyond a comfortable agent-facing surface, and mirrors the full obs-websocket protocol rather than curating what an agent actually needs. While nearly every tool corresponds to a real API call, the resulting selection cost and near-duplicate convenience wrappers (per-output vs per-stream vs generic output tools) make the set unwieldy.

    Completeness4/5

    Coverage is exceptionally broad — scenes, scene items, inputs, filters, transitions, outputs, profiles, scene collections, media control, and hotkeys all have create/read/update/delete coverage. A few gaps remain, such as no get/set-input-properties or source settings (only private settings), and no remove-scene-collection, but these are minor and workable.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      B
      quality
      D
      maintenance
      Enables AI assistants to control and automate OBS Studio via natural language, covering scenes, sources, audio, recording, streaming, transitions, filters, media playback, diagnostics, and multi-step workflows over the OBS WebSocket protocol.
      89
      MIT
    • A
      license
      B
      quality
      B
      maintenance
      Enables MCP clients to control OBS Studio through an inspectable WebSocket interface. Provides 155 tools for managing scenes, sources, audio, transitions, filters, recording, and streaming through natural language.
      155
      598 npm
      4
      MIT
    • A
      license
      Not graded
      quality
      B
      maintenance
      Enables typed, native control of OBS Studio—scene/source discovery and recording start/stop/pause/resume with status readbacks—through a secure loopback WebSocket interface.
      GPL 2.0
    • A
      license
      A
      quality
      C
      maintenance
      Enables AI assistants to inspect and safely control OBS Studio over obs-websocket v5, exposing scenes, inputs, filters, outputs and video settings as read and write tools that default to dry runs and refuse changes while live unless explicitly confirmed. It also provides Source Record and IRL readiness checks, a BRB auto-switcher, and a scene timeline log for cutting clips from VODs.
      17
      MIT