delimit_docs_generate

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

Without annotations, description partially discloses behavior: scans Python and JS/TS files, produces markdown. Missing details on file creation, overwrite behavior, or error handling. Not contradictory but incomplete.

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 sentences that are direct and essential. No extraneous information, well-structured.

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?

Output schema exists but is not shown in the description; still, the tool is simple with one parameter. Lacks details on output location, file handling, or behavior when no docstrings are found.

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 coverage is 100%, so description adds minimal value beyond the schema's 'Project path.' The description does not elaborate on relative paths or default behavior, meeting baseline.

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 generates API reference documentation for a project, with a specific verb and resource. Differentiates from sibling like delimit_docs_validate by focusing on generation.

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?

No guidance on when to use this tool vs alternatives like delimit_docs_validate or other generation tools. The description implies usage but does not specify exclusions or prerequisites.

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