docs_read

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

Annotations declare readOnlyHint=true and destructiveHint=false, and the description adds specific behaviors: handles multiple formats (HTML, JSON, YAML, etc.), PDFs under 5MB, and returns related documentation links. Fully consistent with annotations and provides extra detail.

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 two paragraphs: one explaining functionality and one giving instructions. It is mostly concise but could be slightly more streamlined. The key information is front-loaded.

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?

For a read tool with no output schema, the description fully explains the output format (Markdown) and includes handling of multiple input types and extraction of related links. Also provides actionable instructions for the agent.

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?

Input schema has 100% coverage with descriptions for both parameters. The description adds value by explaining the tool returns Markdown and handles various input formats, which is not in the schema. Slight redundancy but acceptable.

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 tool reads documentation pages and returns clean Markdown, listing supported formats. It distinguishes from sibling tools like docs_discover and docs_search by focusing on reading a specific page.

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 instructs to 'ALWAYS check these links for authentication and getting-started pages before generating code,' providing clear guidance on when and how to use the tool's output. Implicitly suggests using this tool for reading docs rather than discovering or extracting.

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