read_documentation

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

With no annotations provided, the description must carry the full burden of behavioral disclosure. It states the main action (read and convert to Markdown) but does not mention any side effects, prerequisites, or edge cases (e.g., how 'main content' is determined, whether it is a network call, or error behavior). This provides some transparency but lacks depth.

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?

The description is a single, concise sentence that front-loads the core action ('Read a chezmoi documentation page') and adds the key detail of Markdown conversion. No unnecessary words or repetition.

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?

Given the tool's simplicity (one parameter, output schema present, no nested objects), the description covers the essential behavior. However, it does not mention the existence of siblings or when to choose this over them, but for a straightforward read operation the description is reasonably complete.

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 description coverage is 0%, so the description must compensate. The single parameter 'url' is given meaning by the description's reference to 'a chezmoi documentation page', indicating the URL points to that page. This adds enough context beyond the bare parameter name, though it could be more explicit about URL formats.

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 a specific verb 'read' and resource 'chezmoi documentation page', and adds the conversion detail 'convert its main content to Markdown'. This distinguishes it from siblings like search_documentation (search) and list_documentation_pages (list) by focusing on retrieving a specific page's content.

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?

The description implies usage when you need a specific documentation page's content as Markdown, but does not explicitly state when to use this tool versus the siblings or provide any exclusions. There is clear context but no explicit comparison or conditions, so it stops short of strong guidance.

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