OBS MCP Server
Utilizes Node.js as the runtime environment for the MCP server, with Node.js 16+ being a requirement for operation.
Connects to OBS Studio via the WebSocket protocol, providing tools for scene management, source control, streaming/recording control, transitions, and general operations in OBS.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@OBS MCP Server switch to my gaming scene"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
OBS MCP Server
An MCP server for OBS Studio that provides tools to control OBS via the OBS WebSocket protocol.
Features
Connect to OBS WebSocket server
Control OBS via MCP tools
Provides tools for:
General operations
Scene management
Source control
Scene item manipulation
Streaming and recording
Transitions
Related MCP server: obs-showrunner-mcp
Usage
Make sure OBS Studio is running with WebSocket server enabled (Tools > WebSocket Server Settings). Note the password for the WS.
Set the WebSocket password in environment variable (if needed):
export OBS_WEBSOCKET_PASSWORD="your_password_here"Add the MCP server to Claude desktop with the MCP server settings:
{
"mcpServers": {
"obs": {
"command": "npx",
"args": ["-y", "obs-mcp@latest"],
"env": {
"OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
}
}
}
}Use Claude to control your OBS!
Development
If you want to run the server locally using the code in this git repo, you can do the following:
npm run build
npm run startThen configure Claude desktop:
{
"mcpServers": {
"obs": {
"command": "node",
"args": [
"<obs-mcp_root>/build/index.js"
],
"env": {
"OBS_WEBSOCKET_PASSWORD": "<password_from_obs>"
}
}
}
}Available Tools
The server provides tools organized by category:
General tools: Version info, stats, hotkeys, studio mode
Scene tools: List scenes, switch scenes, create/remove scenes
Source tools: Manage sources, settings, audio levels, mute/unmute
Scene item tools: Manage items in scenes (position, visibility, etc.)
Streaming tools: Start/stop streaming, recording, virtual camera
Transition tools: Set transitions, durations, trigger transitions
Environment Variables
OBS_WEBSOCKET_URL: WebSocket URL (default: ws://localhost:4455)OBS_WEBSOCKET_PASSWORD: Password for authenticating with OBS WebSocket (if required)
Requirements
Node.js 16+
OBS Studio 31+ with WebSocket server enabled
Claude desktop
License
See the LICENSE file for details.
Available Tools
127 toolsobs-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: sceneName (required), inputName (required), inputKind (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: sourceName (required), filterName (required), filterKind (required), filterSettings.
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-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-default-settingsC
Gets the default settings for an input kind
Inputs: inputKind (required).
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-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: parameterCategory (required), parameterName (required).
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-idB
Get the ID of a scene item by its source name
Inputs: sceneName (required), sourceName (required).
obs-get-scene-itemsC
Get a list of all scene items in a scene
Inputs: sceneName (required).
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-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: sourceName (required), filterName (required).
obs-get-source-filter-listB
Gets an array of all of a source's filters
Inputs: sourceName (required).
obs-get-source-screenshotC
Gets a Base64-encoded screenshot of a source
Inputs: imageFormat (required), sourceName, sourceUuid, imageWidth, +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-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-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-remove-inputC
Removes an existing input
Inputs: inputName (required).
obs-remove-profileA
Removes a profile. If the current profile is chosen, it will change to a different profile first
Inputs: profileName (required).
obs-remove-sceneC
Remove a scene from OBS
Inputs: sceneName (required).
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: sourceName (required), filterName (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), sourceName, sourceUuid, +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).
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-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), inputVolumeMul, inputVolumeDb.
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: parameterCategory (required), parameterName (required), parameterValue (required).
obs-set-record-directoryC
Sets the current directory that the record output writes files to
Inputs: recordDirectory (required).
obs-set-scene-item-enabledC
Show or hide a scene item
Inputs: sceneName (required), sceneItemId (required), enabled (required).
obs-set-scene-item-transformC
Set the position, rotation, scale, or crop of a scene item
Inputs: sceneName (required), sceneItemId (required), positionX, positionY, +7 more.
obs-set-source-filter-enabledC
Sets the enable state of a source filter
Inputs: sourceName (required), filterName (required), filterEnabled (required).
obs-set-source-filter-indexC
Sets the index position of a filter on a source
Inputs: sourceName (required), filterName (required), filterIndex (required).
obs-set-source-filter-nameC
Sets the name of a source filter (rename)
Inputs: sourceName (required), filterName (required), newFilterName (required).
obs-set-source-filter-settingsC
Sets the settings of a source filter
Inputs: sourceName (required), filterName (required), filterSettings (required), overlay.
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-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: fpsNumerator, fpsDenominator, baseWidth, baseHeight, +2 more.
obs-sleepB
Sleeps for a time duration or number of frames
Inputs: sleepMillis, sleepFrames.
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: no named parameters.
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-streamB
Stop streaming in OBS
Inputs: no named parameters.
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-streamB
Toggle the streaming state in OBS
Inputs: no named parameters.
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
Scored across 127 tools
Most tools have distinct purposes, but there is some overlap in get/set operations for similar properties (e.g., multiple audio-related get/set tools for inputs) that could cause minor confusion. However, the descriptions are clear enough to differentiate them in most cases.
All tools follow a consistent 'obs-verb-noun' pattern with clear, descriptive names. The naming is uniform throughout, making it easy to predict tool functions and maintain readability.
With 127 tools, the count is excessively high for a single server, making it overwhelming and difficult to navigate. This suggests poor scoping, as many tools could potentially be consolidated or grouped more efficiently.
The tool set provides comprehensive coverage of OBS operations, including CRUD for inputs, scenes, filters, and outputs, as well as status checks, controls, and utilities. No obvious gaps are present for the domain.
Maintenance
Related MCP Connectors
Remote MCP server for Web3TV creators — manage your account over MCP.
Remote MCP server exposing SMI Aware tools, resources, and skills over Streamable HTTP.
One MCP server for all your MCP servers: code mode, per-tool permissions, approvals and audit.
The official MCP Server for the Mux API
Related MCP Servers
- AlicenseAqualityDmaintenanceAn MCP (Model Context Protocol) server for controlling OBS Studio via the built-in obs-websocket plugin. Lets Claude control your scenes, recording, streaming, audio, and more.2611 npm1MIT
- AlicenseBqualityDmaintenanceMCP server enabling LLMs to control OBS Studio through high-level show and effect APIs.18MIT
- AlicenseBqualityDmaintenanceMCP server for controlling OBS Studio via obs-websocket, enabling scene switching, source management, streaming, recording, and text overlays through natural language.36152 PyPI5MIT
- AlicenseAqualityDmaintenanceAn MCP server for OBS Studio that subscribes to events and maintains a history, enabling queries about audio levels, source states, and past actions rather than only one-shot requests.67MIT