Export Project To File

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

Description says it writes to disk, contradicting the readOnlyHint=true annotation. This is a serious inconsistency. Beyond that, description adds context about requiring open project and returning summary, but contradiction overrides.

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: first explains action, second gives usage guidance with sibling, third notes prerequisite. No unnecessary words.

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, but description notes return values (output path and summary). Missing details about default output path behavior, but overall adequate for a simple export tool.

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?

Schema has 100% coverage for all three parameters. Description adds no extra parameter details beyond listing formats already in the schema enum.

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?

Description clearly states the tool exports the whole project to a file in specified formats (Markdown, HTML, JSON, EPUB) and returns the output path and summary. It distinguishes from sibling tool compile_documents.

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?

Explicitly tells when to use this tool vs compile_documents: use for deliverable file, use compile_documents for text in response. Also notes prerequisite of an open project.

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