Render document to a file

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

Discloses write behavior to build/.cache/rendered/, non-mutation of data/meta.yaml, and idempotent nature. Consistent with annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=true). Adds context beyond annotations.

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?

All sentences serve a purpose: purpose, usage, args, returns. Front-loaded with action and context. No fluff.

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?

Fully covered: purpose, usage, parameters, output schema, sibling relationships. Output schema is described in text. Annotations present. No gaps.

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?

Each parameter is described in the description with additional context (e.g., doc_id discovery via list_docs). Schema coverage is 100%, but description adds value by linking parameters to tool usage workflow.

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?

Clearly states it renders a template-driven document to disk. Distinguishes itself as the only write tool among siblings, using specific verb 'render' and explicit resource 'registered template-driven document'.

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 explicit when-to-use (materialise before compile/audit), what it does not do (never mutates data/meta.yaml), and suggests discovery with list_docs and follow-up with audit_pdf. Also contrasts with sibling tools.

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