syncCollectionWithSpec

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

Adds info beyond annotations: async endpoint returning 202, and supported spec types. Annotations already indicate idempotent, non-destructive, non-read-only; description complements without contradiction.

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 short paragraphs with bullet points for notes, no wasted words. Efficiently conveys all necessary 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?

For a simple sync tool with two parameters and no output schema, description covers async behavior, supported spec versions, and constraints. Complete and sufficient for agent invocation.

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 baseline is 3. Description does not add extra meaning beyond schema definitions for collectionUid and specId.

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 it syncs a collection from an API spec, specifying async behavior and constraints on supported spec types and collection origin. Distinguishes from siblings like syncSpecWithCollection.

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?

Provides explicit context on when to use, including supported spec types and requirement that collection was generated from the given spec ID. Does not explicitly mention alternatives or when not to use, but constraints serve as guidance.

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