Skip to main content
Glama

Export handoff Markdown

export_handoff_markdown

Export a checkpoint to HANDOFF.md in the project root so AI agents can resume from the exact stopping point, refusing overwrite unless overwrite=true.

Instructions

Write the checkpoint to HANDOFF.md in the project root; refuses to overwrite unless overwrite=true.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
overwriteNo
projectPathYesAbsolute path of the workspace/project root

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It usefully discloses the target file path and a critical guard (refuses to overwrite unless overwrite=true), but omits other important behaviors such as whether it creates the file if missing, permission requirements, or what happens to existing content.

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?

A single, front-loaded sentence that states the action, target location, and overwrite guard with zero wasted words. The structure makes the key behavior immediately scannable.

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?

For a simple write tool with no output schema or annotations, the description covers the destination and overwrite behavior but leaves a significant ambiguity: it writes 'the checkpoint' without explaining where that checkpoint data comes from, since no checkpoint parameter exists. It also omits return value information and usage context relative to siblings.

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 coverage is only 50%, but the description compensates by explaining the undocumented overwrite parameter's effect and default behavior. The projectPath parameter is already well documented in the schema as an absolute path, so all parameters now have useful semantics.

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?

States a specific verb (write) and resource (the checkpoint to HANDOFF.md in the project root), making it clear this is a file-export tool rather than a state mutation. However, it does not explicitly differentiate itself from siblings like save_handoff or update_handoff, leaving the agent to infer the distinction.

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?

The description provides no when-to-use guidance, prerequisites, or alternatives. It explains the overwrite behavior but does not say when this tool should be chosen over save_handoff, update_handoff, or prepare_handoff.

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