Site Openapi

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive. The description adds critical behavioral details: no JavaScript execution, no access control bypass, and cache reuse behavior. This complements annotations well.

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 that front-load the purpose and include necessary usage constraints. Every sentence adds value, no 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 and full parameter description coverage, the description is complete. It clearly defines the tool's scope and constraints, and the sibling context shows specialisation. No gaps.

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 adds practical usage advice: 'Pass url as an absolute public HTTP(S) URL' and caching guidance for 'fresh'. This provides more context than the schema alone.

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 the tool discovers and summarizes bounded public OpenAPI documents, clearly distinguishing it from sibling URL tools that handle general web content. The verb 'discover and summarize' and resource 'OpenAPI documents' are specific.

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 explicitly restricts use to public HTTP(S) resources, notes that it doesn't execute JavaScript or bypass access controls, and provides guidance on the 'fresh' parameter. It does not directly name alternatives but the context of OpenAPI documents implies when not to use this tool (e.g., non-OpenAPI content).

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