get_api

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

No annotations provided. Description lists the data it returns but does not explicitly state that it is a read-only operation with no side effects, nor does it mention auth requirements or rate limits. Adequate for a get-details tool.

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?

Two sentences front-loading the return value list and usage guidance. Every sentence provides value.

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?

With one parameter and no output schema, the description covers all necessary information: what is returned, how to use it (before call_api), and how to get the slug. Complete for this context.

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 100%; parameter has description in schema. The tool description adds 'Get slugs from list_apis or search_apis' which is already in schema. Baseline 3 is appropriate.

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?

Clearly states it gets full details for a specific API, listing components. Distinguishes from list_apis/search_apis by specifying 'a specific API' and mentions use case before call_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?

Explicitly states 'Use this before calling call_api' and references list_apis/search_apis for slug retrieval. Does not list exclusions but provides clear usage context.

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