Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| OBS_WEBSOCKET_URL | No | WebSocket URL for connecting to OBS Studio | ws://localhost:4455 |
| OBS_WEBSOCKET_PASSWORD | No | Password for authenticating with OBS WebSocket (if required) |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| obs-get-status | Get the current status of the OBS MCP server and OBS connection |
| obs-get-version | Get OBS Studio version information |
| obs-test-connection | Test the connection to OBS WebSocket |
| obs-get-stats | Gets statistics about OBS, obs-websocket, and the current session |
| obs-broadcast-custom-event | Broadcasts a CustomEvent to all WebSocket clients |
| obs-call-vendor-request | Call a request registered to a vendor |
| obs-get-hotkey-list | Gets an array of all hotkey names in OBS |
| obs-trigger-hotkey-by-name | Triggers a hotkey using its name |
| obs-trigger-hotkey-by-key-sequence | Triggers a hotkey using a sequence of keys |
| obs-sleep | Sleeps for a time duration or number of frames |
| obs-get-scene-list | Get a list of scenes in OBS |
| obs-get-current-scene | Get the current active scene in OBS |
| obs-set-current-scene | Set the current active scene in OBS |
| obs-get-preview-scene | Get the current preview scene in OBS Studio Mode |
| obs-set-preview-scene | Set the current preview scene in OBS Studio Mode |
| obs-create-scene | Create a new scene in OBS |
| obs-remove-scene | Remove a scene from OBS |
| obs-trigger-studio-transition | Trigger a transition from preview to program scene in Studio Mode |
| obs-get-source-active | Gets the active and show state of a source |
| obs-get-source-screenshot | Gets a Base64-encoded screenshot of a source |
| obs-save-source-screenshot | Saves a screenshot of a source to the filesystem |
| obs-get-scene-items | Get a list of all scene items in a scene |
| obs-create-scene-item | Create a scene item for a source in a scene |
| obs-remove-scene-item | Remove a scene item from a scene |
| obs-set-scene-item-enabled | Show or hide a scene item |
| obs-get-scene-item-transform | Get the position, rotation, scale, or crop of a scene item |
| obs-set-scene-item-transform | Set the position, rotation, scale, or crop of a scene item |
| obs-get-scene-item-id | Get the ID of a scene item by its source name |
| obs-get-stream-status | Get the current streaming status |
| obs-start-stream | Start streaming in OBS |
| obs-stop-stream | Stop streaming in OBS |
| obs-toggle-stream | Toggle the streaming state in OBS |
| obs-send-stream-caption | Sends CEA-608 caption text over the stream output |
| obs-get-transition-list | Get a list of available transitions in OBS |
| obs-get-current-transition | Get the name of the currently active transition |
| obs-set-current-transition | Set the current transition in OBS |
| obs-get-transition-duration | Get the duration of the current transition in milliseconds |
| obs-set-transition-duration | Set the duration of the current transition in milliseconds |
| obs-get-transition-kind | Get the kind/type of the current transition |
| obs-set-transition-settings | Set the settings of the current transition |
| obs-get-transition-settings | Get the settings of the current transition |
| obs-trigger-transition | Trigger a scene transition in OBS (Studio Mode must be enabled) |
| obs-get-persistent-data | Gets the value of a slot from the selected persistent data realm |
| obs-set-persistent-data | Sets the value of a slot from the selected persistent data realm |
| obs-get-scene-collection-list | Gets an array of all scene collections |
| obs-set-current-scene-collection | Switches to a scene collection |
| obs-create-scene-collection | Creates a new scene collection, switching to it in the process |
| obs-get-profile-list | Gets an array of all profiles |
| obs-set-current-profile | Switches to a profile |
| obs-create-profile | Creates a new profile, switching to it in the process |
| obs-remove-profile | Removes a profile. If the current profile is chosen, it will change to a different profile first |
| obs-get-profile-parameter | Gets a parameter from the current profile's configuration |
| obs-set-profile-parameter | Sets the value of a parameter in the current profile's configuration |
| obs-get-video-settings | Gets the current video settings |
| obs-set-video-settings | Sets the current video settings |
| obs-get-stream-service-settings | Gets the current stream service settings |
| obs-set-stream-service-settings | Sets the current stream service settings |
| obs-get-record-directory | Gets the current directory that the record output is set to |
| obs-set-record-directory | Sets the current directory that the record output writes files to |
| obs-get-filter-kind-list | Gets an array of all available source filter kinds |
| obs-get-source-filter-list | Gets an array of all of a source's filters |
| obs-get-filter-default-settings | Gets the default settings for a filter kind |
| obs-create-source-filter | Creates a new filter, adding it to the specified source |
| obs-remove-source-filter | Removes a filter from a source |
| obs-set-source-filter-name | Sets the name of a source filter (rename) |
| obs-get-source-filter | Gets the info for a specific source filter |
| obs-set-source-filter-index | Sets the index position of a filter on a source |
| obs-set-source-filter-settings | Sets the settings of a source filter |
| obs-set-source-filter-enabled | Sets the enable state of a source filter |
| obs-get-input-list | Gets an array of all inputs in OBS |
| obs-get-input-kind-list | Gets an array of all available input kinds in OBS |
| obs-get-special-inputs | Gets the names of all special inputs |
| obs-create-input | Creates a new input, adding it as a scene item to the specified scene |
| obs-remove-input | Removes an existing input |
| obs-set-input-name | Sets the name of an input (rename) |
| obs-get-input-default-settings | Gets the default settings for an input kind |
| obs-get-input-settings | Gets the settings of an input |
| obs-set-input-settings | Sets the settings of an input |
| obs-get-input-mute | Gets the audio mute state of an input |
| obs-set-input-mute | Sets the audio mute state of an input |
| obs-toggle-input-mute | Toggles the audio mute state of an input |
| obs-get-input-volume | Gets the current volume setting of an input |
| obs-set-input-volume | Sets the volume setting of an input |
| obs-get-input-audio-balance | Gets the audio balance of an input |
| obs-set-input-audio-balance | Sets the audio balance of an input |
| obs-get-input-audio-sync-offset | Gets the audio sync offset of an input |
| obs-set-input-audio-sync-offset | Sets the audio sync offset of an input |
| obs-get-input-audio-monitor-type | Gets the audio monitor type of an input |
| obs-set-input-audio-monitor-type | Sets the audio monitor type of an input |
| obs-get-media-input-status | Gets the status of a media input |
| obs-set-media-input-cursor | Sets the cursor position of a media input |
| obs-offset-media-input-cursor | Offsets the current cursor position of a media input |
| obs-trigger-media-input-action | Triggers an action on a media input |
| obs-get-virtual-cam-status | Gets the status of the virtualcam output |
| obs-toggle-virtual-cam | Toggles the state of the virtualcam output |
| obs-start-virtual-cam | Starts the virtualcam output |
| obs-stop-virtual-cam | Stops the virtualcam output |
| obs-get-replay-buffer-status | Gets the status of the replay buffer output |
| obs-toggle-replay-buffer | Toggles the state of the replay buffer output |
| obs-start-replay-buffer | Starts the replay buffer output |