generateSpecFromCollection

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

Mentions 'Returns polling link to task status' which indicates asynchronous behavior, a key trait beyond schema. However, no annotations exist, and the description does not disclose other aspects like permissions or whether it's idempotent.

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-loaded with the core action. No unnecessary words.

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?

The tool is relatively complex (5 required params, no output schema, async with polling link) but the description is minimal. It doesn't explain how to interpret the polling link, the format of the generated spec, or what happens if the collection doesn't exist. Leaves gaps for an agent to infer.

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%, so baseline is 3. The description adds no extra meaning beyond the parameter descriptions already in the schema. All parameters are briefly described in schema, and description does not elaborate.

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 action ('Generates an API spec') and the resource ('collection'). This distinguishes it from siblings like createSpec (creates spec from scratch) and syncCollectionWithSpec (syncs existing).

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?

No guidance on when to use this vs alternatives like createSpec or syncCollectionWithSpec. Missing context about prerequisites or when to prefer this tool.

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