Skip to main content
Glama

toggle_recording

Start or stop recording in OBS Studio to capture your screen or streaming content.

Instructions

Toggle OBS recording on/off.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The handler implementation for the toggle_recording tool, which calls OBS ToggleRecord and then fetches the updated recording status.
    case "toggle_recording": {
      await obs.call("ToggleRecord");
      const status = await obs.call("GetRecordStatus");
      return ok({ recording: status.outputActive });
    }
  • The tool registration for toggle_recording.
    {
      name: "toggle_recording",
      description: "Toggle OBS recording on/off.",
      inputSchema: { type: "object", properties: {} },
    },
Behavior3/5

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

With no annotations provided, the description carries full burden. It discloses the toggle behavior (on/off switching) but lacks details on state transitions, idempotency, or side effects (e.g., whether stopping finalizes a file, whether starting creates a new one).

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?

Single sentence with zero redundancy. Action verb front-loaded. Appropriate length for a zero-parameter state toggle.

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

Completeness3/5

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

Adequate for basic invocation but incomplete given the sibling tool ecosystem. Missing guidance on toggle-vs-explicit usage patterns and lacks disclosure of what happens to recording files during state transitions.

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

Parameters4/5

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

Zero parameters exist in the schema, establishing baseline 4 per rubric. No parameter documentation is required or expected.

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

Purpose4/5

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

The description clearly states the action ('Toggle') and resource ('OBS recording'). However, it fails to distinguish from siblings 'start_recording' and 'stop_recording', leaving ambiguity about when to use the toggle pattern versus explicit control.

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

Usage Guidelines2/5

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

No guidance is provided on when to prefer this tool over the explicit 'start_recording' or 'stop_recording' alternatives, nor are prerequisites mentioned (e.g., OBS must be running).

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/LarsCanGit/OBS-MCP'

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