shopify_update_page

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

Annotations already convey readOnly=false, destructive=true, and idempotent=true. The description adds useful workflow context by explaining that effect is a claimed read/write effect verified by Spring and that approval_ref is used when resuming a write. This goes beyond the annotations without contradicting them.

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 a one-sentence summary followed by a flat, scannable Args list. Each parameter line adds concrete meaning, and there is no filler or repetition of the schema's type 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?

Given 10 parameters and zero schema descriptions, the text covers every parameter and key workflow semantics such as effect verification and write resumption. An output schema exists, so return value documentation is not required. The main remaining gap is explicit guidance about when to choose this tool over related Shopify page tools.

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 0%, and the description fully compensates: it defines all ten parameters, including page_id accepted formats, body_html semantics, project correlation fields, idempotency_key, effect verification, and approval_ref. It also correctly flags page_id as required even though the schema does not.

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 opens with a clear verb-resource pair: 'Update an Online Store page's title, body, or publish state.' This explicitly names what the tool mutates and distinguishes it from sibling create/read/list Shopify page tools.

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 clearly implies use when an existing Shopify page needs its title, body, or publish state modified, with page_id identifying the target. It does not explicitly name alternatives or state when not to use it, but the context is unambiguous enough to avoid confusion with sibling tools.

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