Lookup cataloged API

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It reveals two important traits: it rejects unknown ids (error behavior) and does not fetch URLs from the spec (avoiding network side-effects). Even without a return format specification, these disclosures cover the key operational concerns an agent would have.

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, front-loaded with the core action and resource. The second sentence delivers two high-value constraints efficiently. There is zero filler; every word earns its place.

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 simple single-parameter lookup with no output schema and no annotations, the description covers the essential purpose, error handling, and a limitation. It does not describe the return structure (e.g., raw JSON vs. parsed object), but that is a minor gap given the simplicity and the explicit scope of the tool. Overall, an agent can confidently invoke it.

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 input schema already documents apiId with a pattern and example, achieving 100% coverage. The description adds concrete catalog id examples (orders, identity, billing) that go beyond the schema's single example, enriching the parameter's semantic meaning and helping the agent select valid values. This justifies a score above the baseline 3.

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 clearly states the verb 'Return' and the resource 'imported OpenAPI document' with a specific identifier (catalog id). It also gives concrete examples (orders, identity, billing) and implicitly differentiates from siblings like list_catalog (which lists) and get_operation (which fetches a specific operation). The purpose is unambiguous.

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 provides practical usage guidance by stating that unknown ids are rejected (so the agent knows to validate against the catalog) and that it does not fetch URLs from the spec (clarifying a limitation). It does not explicitly name alternatives, but the examples and behavior imply it is for looking up a single document by id, which is sufficient for most agents to route correctly.

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