Skip to main content
Glama
Giancarlo26

obs-action-history

by Giancarlo26

obs_hotkey_trigger

Trigger any OBS hotkey by exact name to invoke plugin features without dedicated websocket requests, enabling custom actions like vertical canvas recording and Advanced Scene Switcher macros.

Instructions

Fire an OBS hotkey action by name - the way to invoke plugin features that have no obs-websocket request of their own. On the reference machine that means the vertical-canvas plugin's separate recording and streaming pipeline (VerticalCanvasDock*) and Advanced Scene Switcher's start/stop and macro segments (*SwitcherHotkey). Get names from obs_hotkey_list.

DANGEROUS NAMES ARE IN THE SAME NAMESPACE. OBSBasic.StopStreaming, OBSBasic.ForceStopStreaming and VerticalCanvasDockStopStreaming all sit in that list and all end a live broadcast instantly; OBSBasic.StartStreaming starts one. There is no undo and no confirmation. This tool refuses nothing, so read the name you are about to send.

DO NOT USE IT AS A SHORTCUT FOR A REAL REQUEST. Duplicated names - libobs.mute, MediaSource.Play, libobs.show_scene_item.N - are registered once per source or scene, and this request takes a bare name, so which one fires is not something you control. Mute with SetInputMute, hide with SetSceneItemEnabled, switch scenes with SetCurrentProgramScene. Hotkeys are for what those cannot reach.

OBS returns success for a name it accepted, not for an effect it produced; verify the thing you wanted actually changed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hotkeyNameYesExact name from obs_hotkey_list, e.g. 'VerticalCanvasDockStartRecording'. Case-sensitive.
contextNameNoOptional context for the hotkey, per the protocol. Note GetHotkeyList returns names only and never contexts, so there is no way to discover a valid value here from the API - omit it unless a plugin's own documentation gave you one.
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description fully bears the transparency burden. It discloses destructive potential (StopStreaming, ForceStopStreaming), no undo/confirmation, refusal to reject any name, duplicate-name ambiguity, and that success means 'name accepted' not 'effect produced'. It also advises verifying outcomes. This is thorough and honest.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Despite being long, every sentence carries critical information: purpose, examples, danger warnings, alternatives, and return semantics. Structurally it is well-organized into clear paragraphs (function, danger, alternatives, verification). No wasted words; density is high and appropriate for a dangerous tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has no output schema and no annotations, yet the description covers all necessary context: how to obtain valid names, destructive consequences, duplicate registration pitfalls, and the need to verify effects. It also provides integration with sibling tools (obs_hotkey_list) and alternative APIs. The description is complete for an agent to use this tool safely.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the schema already thoroughly describes both parameters, including case-sensitivity and context discovery caveats. The description adds marginal value beyond schema—it primarily repeats schema details—but it does reinforce the 'exact name from obs_hotkey_list' requirement and the advice to omit contextName unless plugin docs provide one. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose: 'Fire an OBS hotkey action by name', specifies it's for invoking plugin features without a dedicated request, and provides concrete examples (VerticalCanvasDock*, SwitcherHotkey). It distinguishes from sibling tools like obs_hotkey_list (which lists hotkeys) and obs_hotkey_key (which sends key presses).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly says 'DO NOT USE IT AS A SHORTCUT FOR A REAL REQUEST' and lists specific alternatives like SetInputMute, SetSceneItemEnabled, SetCurrentProgramScene. It also instructs to get names from obs_hotkey_list and cautions about dangerous names. This is exemplary guidance for when to use and when not to use the tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Giancarlo26/obs-action-history'

If you have feedback or need assistance with the MCP directory API, please join our Discord server