generateSpecFromCollection

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

Annotations already indicate this is a non-readOnly, non-destructive, non-idempotent operation. The description adds valuable context by disclosing that the response contains a polling link to task status, revealing this is an asynchronous operation. However, it doesn't provide details about rate limits, authentication needs, or error conditions beyond what annotations cover.

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 extremely concise at just two sentences, with zero wasted words. It's front-loaded with the core purpose and efficiently adds the crucial behavioral detail about polling. Every sentence 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 tool with 5 required parameters, no output schema, and annotations covering basic behavioral hints, the description provides the minimum viable information. It states what the tool does and reveals the asynchronous nature, but doesn't explain what happens after polling completes or provide context about the generated specification's format or location.

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%, so the schema fully documents all 5 parameters. The description doesn't add any additional meaning or clarification about the parameters beyond what's already in the schema. This meets the baseline expectation when schema coverage is complete.

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 tool's purpose: 'Generates an API specification for the given collection.' This is a specific verb+resource combination. However, it doesn't explicitly differentiate from sibling tools like 'createSpec' or 'getAllSpecs', which might have overlapping functionality.

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 provides no guidance on when to use this tool versus alternatives. With siblings like 'createSpec', 'getAllSpecs', and 'syncCollectionWithSpec', there's no indication of prerequisites, appropriate contexts, or exclusions. This leaves the agent guessing about the right tool selection.

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