Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| OBS_WS_URL | No | The WebSocket URL for OBS Studio (e.g., ws://localhost:4455). | ws://localhost:4455 |
| OBS_WS_PASSWORD | No | The password set in OBS WebSocket Server Settings. |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_status | Get current OBS status: active scene, streaming state, recording state. |
| list_scenes | List all scenes in OBS. |
| set_scene | Switch OBS to a different scene. |
| start_recording | Start OBS recording. |
| stop_recording | Stop OBS recording. |
| toggle_recording | Toggle OBS recording on/off. |
| start_streaming | Start OBS streaming. |
| stop_streaming | Stop OBS streaming. |
| list_sources | List all sources (scene items) in a scene. Defaults to the current scene. |
| set_source_visibility | Show or hide a source in a scene. |
| list_audio_inputs | List all audio input sources (mics, desktop audio, etc.). |
| set_mute | Mute or unmute an audio input. |
| toggle_mute | Toggle mute on an audio input. |
| set_volume | Set the volume of an audio input (0.0 – 1.0, linear mul). |
| save_screenshot | Save a screenshot of the current OBS output to a file. |
| set_canvas_resolution | Set the OBS canvas (base) and output resolution. Applies globally — affects all scenes in the current collection. |
| create_scene | Create a new empty scene in OBS. |
| remove_scene | Delete a scene from OBS. Cannot remove the currently active scene. |
| rename_scene | Rename an existing scene. |
| list_scene_collections | List all scene collections and show which one is active. |
| set_scene_collection | Switch to a different scene collection. OBS will reload its scenes. |
| create_scene_collection | Create a new scene collection (starts empty). |
| list_profiles | List all OBS profiles and show which one is active. |
| set_profile | Switch to a different OBS profile (stream settings, encoder config, etc.). |
| create_profile | Create a new OBS profile. |
| remove_profile | Delete an OBS profile. Cannot remove the currently active profile. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |