Query Documentation

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

Annotations already indicate readOnlyHint=true. The description adds behavioral context such as the 3-call limit and the prerequisite for library ID, but does not describe the return format. Still, it adds meaningful value 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?

The description is split into three short paragraphs, each serving a clear purpose: purpose, prerequisite/alternative, and usage limit. Every sentence is necessary and front-loaded with core info.

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 complexity (no output schema, two required params), the description covers key aspects: what it does, how to get the library ID, usage limit, and query quality. It is sufficiently complete for an AI 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?

Schema coverage is 100% with descriptions for both parameters. The description further clarifies the libraryId sourcing (from resolve-library-id or user query) and provides query specificity guidance ('Be specific and include relevant details'), adding value beyond the schema.

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 'Retrieves and queries up-to-date documentation and code examples' with a specific verb and resource. It distinguishes from the sibling tool 'resolve-library-id' by explaining the prerequisite and alternative.

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 call 'resolve-library-id' first and when not to. Also imposes a clear limit of no more than 3 calls per question, providing both when-to-use and when-to-stop guidance.

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