Skip to main content
Glama

recording_start

Start capturing an active output or region into a silent MP4, WebM, or GIF artifact; returns immediately, then finish with stop and poll status until complete or failed.

Instructions

Start recording an active output (or a region within it) into a silent artifact: H.264 MP4 by default, or AV1 WebM, or a constrained GIF fallback. Returns immediately; call recording_stop to finish, then poll recording_status until the phase is completed or failed. The pointer cursor is always included. Narration anchors come from the timeline streams ingested for this take, so the tool server that drives the demonstration has to publish one.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
formatNomp4: silent H.264 MP4 at 30 fps (default, widest compatibility); webm: silent AV1 WebM at 30 fps; gif: constrained fallback at 12 fps, 960 px maximum width.mp4
outputNoExact Sway output name; inferred when exactly one output is active.
regionNoRegion fully contained in the selected output.
timeline_sourcesNoStream files to ingest for this take. Defaults to every *.jsonl file in streams/ under the seshat runtime directory. Paths are validated when the take starts.
max_duration_secondsNoAutomatic stop deadline. Defaults to 60 (mp4/webm) or 15 (gif); GIF recordings are capped at 15 seconds.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations provided, the description carries the burden and discloses key traits: it is asynchronous (returns immediately), records a silent artifact, always includes the pointer cursor, and depends on timeline streams being published for narration anchors. It does not cover permission requirements, error behavior, or where artifacts are stored.

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?

The description is four tightly written sentences, front-loading the action and format options, then the workflow, then two key behavioral notes. Every sentence contributes information without repetition.

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 five-parameter recording tool with no annotations and no output schema, the description supplies the necessary workflow, format context, async behavior, and the timeline dependency. It leaves some operational details like permissions or artifact destination unaddressed, but is otherwise complete.

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?

Schema description coverage is 100%, so the baseline is 3. The description adds operational meaning beyond the schema by tying timeline_sources to narration anchors and requiring the driving tool server to publish a stream, and by clarifying region selection within the active output.

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 states a specific verb and resource: start recording an active output or region into a silent artifact, with formats enumerated. It distinguishes the action from siblings by naming recording_stop and recording_status as the workflow continuation.

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?

It clearly explains that the call returns immediately and that the agent must call recording_stop, then poll recording_status until completion or failure. This gives explicit next steps and alternatives, but does not state when not to use the tool or how it differs from other recording_* siblings such as recording_scenes.

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