Get API Detail

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

With no annotations, the description itself clarifies it is a read operation that returns expanded schemas. It does not mention side effects or permissions, which would be expected for a read tool; however, the warning about not fetching spec URLs indicates safe behavior.

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 composed of two brief, front-loaded sentences that convey all necessary information without redundancy.

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 presence of an output schema, the description sufficiently covers the tool's purpose and usage. It could be enhanced by listing example parameters, but overall it is complete for its complexity.

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 0%, so the description must explain parameters. It says 'module + exact path + HTTP method' but does not define what constitutes a valid module, path format, or HTTP method. No examples are given, leaving the agent to infer from context.

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 states it is the 'Preferred tool for full API documentation' to 'read the server-indexed API detail, including recursively expanded request and response schemas'. This clearly specifies the verb (read), resource (API detail), and distinguishes it from siblings like find_api.

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?

It explicitly says to 'use module + exact path + HTTP method' and warns 'Do not fetch /v2/api-docs, /v3/api-docs, or spec URLs directly', providing clear when and when-not usage guidance.

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