Execute Collection Update

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

Beyond the annotations (readOnlyHint=false, destructiveHint=true), the description adds key behavioral context: the need for confirm_production in production and the risk of rejection when converting collection types. This is exactly the kind of context annotations alone cannot provide.

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 three sentences, each earning its place: the primary purpose, a critical prerequisite, and a fallback alternative. It is front-loaded with the main action and contains no redundant 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?

The description covers the essential purpose, usage, and caveats for a destructive execute operation. However, it does not mention the return value or how to track the operation's status, though such info may be inherited from sibling tools like operation_status. Given no output schema, a slightly higher level of detail would be expected.

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 fully documents all three parameters, so the baseline is 3. The description adds extra meaning by highlighting confirm_production's requirement for production stores, which reinforces and clarifies the schema's description. This is more than just repeating the schema.

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 executes a previewed collection update, distinguishing it from the plan and preview stages. It names the specific action and resource, and the mention of 'previewed' differentiates it from creating a new update.

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 guidance: production stores require confirm_production: true, and if Shopify rejects converting a manual to automated collection, create a new automated collection with collection_create instead. This directly addresses when to use the tool and when to use an alternative.

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