Update Product Display

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

The description adds significant behavioral context beyond annotations by explaining the 'creates if not exists' upsert behavior. This complements the idempotentHint and readOnlyHint=false annotations. It does not describe return values, but this is not critical for an update tool with no output schema.

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 sentences with no redundancy. It front-loads the core purpose and field list, then adds the critical upsert behavior in the second sentence. Every word contributes to understanding.

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 6-parameter update tool with no output schema, the description adequately covers what it does, the key identifier (handle), the fields affected, and the upsert side effect. It lacks specification of return value, but this is a minor omission for an update operation.

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 schema describes 4 of 6 parameters (67% coverage). The description compensates by mapping 'visibility' to visible, 'featured flag' to featured, 'title and description overrides' to displayTitle/displayDescription, and 'sort order' to order, adding semantic meaning to the two parameters lacking schema descriptions. It does not detail constraints like order direction, but the schema types provide basics.

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 action: updating how a shop product appears on the site by Shopify handle, listing the specific fields (visibility, featured flag, title/description overrides, sort order). It distinguishes from sibling tools by focusing on product display overrides and the upsert nature.

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 clear context: it is used to update display settings for a shop product identified by handle, and mentions the upsert behavior. However, it does not explicitly state when not to use it or name alternative tools (e.g., update_site_content) for different resources.

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