Skip to main content
Glama

obsbot_capture_record

Starts recording the OBSBOT camera to an MP4 file, with optional duration, audio, source, and output path settings. Returns a session ID for stopping the recording.

Instructions

Start recording the camera to an MP4 (for the user). durationSec optional (open-ended recordings auto-stop after 60 min); audio defaults to on (the OBSBOT mic); outputPath optional (defaults to ~/Videos/OBSBOT on every platform, including macOS, where that is NOT the usual ~/Movies). NOTE: before calling, ensure the camera is focused (call obsbot_focus_auto for autofocus) unless otherwise directed. source: device|virtual|ndi. Returns a sessionId for obsbot_capture_stop.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "obsbot_capture_record"
  }
}

Input Schema

NameRequiredDescriptionDefault
audioNo
sourceNodevice
outputPathNo
durationSecNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.9.6
    • removedInput schema / properties / durationSec / allOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "exclusiveMinimum": 0,
      -    "type": "number"
      -  }
      -]
    • addedInput schema / properties / durationSec / exclusiveMinimum
      Added value: +0
    • addedInput schema / properties / durationSec / type
      Added value: +"number"
  2. Addedv0.7.0
  3. Removedv0.6.2
  4. First observedv0.6.2

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations supplied, the description carries the full burden and does well: it discloses the 60-minute auto-stop for open-ended recordings, that audio defaults to the OBSBOT mic, the exact default output directory, and the returned sessionId. It omits what happens if a recording is already in progress and whether an existing file at outputPath is overwritten.

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

Conciseness4/5

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

The essential action and duration caveat are front-loaded, and every parenthetical carries real information (default path, macOS warning, autofocus prerequisite). The semicolon-chained run-on style packs a lot into one block and would read better as short sentences or bullets, but there is no wasted filler.

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

Completeness4/5

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

For a four-parameter capture tool with no annotations and no output schema, the description covers defaults, side effects, the prerequisite, and the return value (sessionId), which is what an agent needs to call it correctly. Remaining gaps are edge-case behaviors (concurrent recording, file overwrite, file naming) rather than blocking omissions.

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 description coverage is 0%, so the description must compensate, and it does for three of four parameters: durationSec (optional, 60-min auto-stop), audio (defaults on, uses OBSBOT mic), and outputPath (platform-wide default with a macOS caveat). However, 'source: device|virtual|ndi' only restates the enum values without explaining what each source means or when to choose it, leaving that important parameter semantically empty.

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?

States a specific verb and resource: 'Start recording the camera to an MP4', and immediately frames the user-facing purpose ('for the user'). It also names the natural downstream sibling (obsbot_capture_stop) via the returned sessionId, so an agent can distinguish this from snapshot/photo siblings without opening the schema.

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

Usage Guidelines4/5

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

Gives an explicit precondition ('ensure the camera is focused (call obsbot_focus_auto for autofocus) unless otherwise directed') and a clear next step (pass sessionId to obsbot_capture_stop). It does not explain when to prefer this over the sibling recording tool obsbot_tail2_record or over snapshot capture, so the alternative-selection guidance is incomplete.

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

Deploy Server

Other Tools