stop_recordingEnd the current Recordful recording to open it in the editor and return the editor tab ID when known.
Stop the current Recordful recording. Recordful then opens its editor with the recording, exactly as when the user clicks Stop. Returns the editor tab ID when it is known.
| Name | Required | Description | Default |
|---|---|---|---|
| timeoutMs | No | Maximum time to wait for the recorder to reach the new state, in milliseconds. |
Changes observed during successful MCP inspections.
v0.3.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations state destructiveHint=false and readOnlyHint=false, but the description adds the key non-obvious behavior: stopping also opens the editor exactly as a manual Stop click would. This side effect is real added value beyond the annotations. It doesn't cover timeout semantics, but the schema does.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two tightly written sentences, front-loaded with the core action, followed by the editor side effect and return value. No filler.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
A single optional-param, no-output-schema tool with annotations covering safety. The description covers the essential side effect and return shape (editor tab ID when known). Lacking only explicit precondition (recording in progress) and behavior when no recording is active.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Only one optional parameter (timeoutMs), and schema coverage is 100% with its own description. With zero required params, the baseline is 4; the description adds no param detail but nothing is needed.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource (stop the current Recordful recording) and is clearly distinguished from siblings like start_recording, pause_recording, and resume_recording. The agent knows exactly which lifecycle action this performs.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Implied usage is clear from the name and the surrounding recording lifecycle siblings, but the description never explicitly states when to prefer this over pause_recording (temporary halt vs. finalize) or that a recording must be in progress. Minor ambiguity remains for the stop-vs-pause decision.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.