describe_api

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

Describes read-only behavior of returning schema with no side effects. No annotations provided, but description adequately covers behavioral traits.

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 concise sentences, front-loaded with purpose, no redundant information.

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?

Description covers essential purpose and usage. Without output schema, return format could be more detailed, but sufficient for a simple schema-query tool.

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?

Single parameter described with example (krstockQuoteCurrentPrice) and source (list_apis). Adds value beyond schema's description.

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?

Description clearly states returns schema of input fields for a specific operationId. Distinct from sibling tools like list_apis (lists APIs) and call_api (makes calls).

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 says 'check what parameters are needed before calling call_api', giving clear when-to-use guidance. Could mention alternatives but not necessary.

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