mail_migrate

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

Describes the process: scans .md files, generates id from filename timestamp + nanoid, only for files missing id, rewrites atomically. Good detail given no annotations; missing state about files with existing id.

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?

Three sentences, front-loaded with verb and object, no wasted words. Efficient and scannable.

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?

No output schema; description does not specify return values or failure modes. Lacks details on file matching and atomic rewrite guarantees. Somewhat complete but missing key aspects.

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?

The description mentions folder and dry_run but does not explain the 'agent' parameter, which is an enum with unclear purpose. Schema provides no descriptions, so parameter semantics are weak.

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?

The description clearly states the action (backfill id frontmatter) and resource (hand-written legacy briefs in a given folder). It distinguishes from sibling mail tools which handle email operations, so purpose is unambiguous.

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?

Provides a clear instruction to use 'dry_run: true' first for preview. No explicit comparison to alternatives, but siblings are different domains, so it's adequately guided.

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