help

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is covered. The description adds the useful context that topic-specific documentation supplements compressed descriptions, but it does not disclose output characteristics such as format or size. Given the annotations, this is adequate.

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 short sentences with no filler. The purpose is front-loaded and the usage rule is stated directly and economically.

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 single optional parameter with an enum and read-only/idempotent annotations, the description plus schema covers all invocation decisions. It does not specify the return format, but for a text documentation tool this is a minor gap, especially with no output schema present.

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?

The schema provides 100% coverage and already explains the topic parameter and the omit-to-read-overview behavior. The description adds extra meaning by saying when a topic should be used (when compressed descriptions are insufficient), which helps the agent choose between overview and a specific topic.

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 phrase 'Full documentation' identifies the resource this tool serves, and 'Omit topic for the overview; use a topic' clarifies that it provides documentation content on demand. It is clear enough, though it lacks an explicit verb like 'retrieves' and does not directly contrast itself with the sibling tools.

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 gives an explicit decision rule: omit the topic for the overview, and request a specific topic only when compressed descriptions are insufficient. This tells the agent exactly when to invoke the tool and when the existing descriptions should already suffice.

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