shopify_add_customer_note

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

No annotations provided, so description bears full weight. It discloses append behavior (reads current note, concatenates with two newlines) and replace behavior (overwrites), plus the extra read query for append. Lacks info on auth or rate limits, but core mutation behavior is well covered.

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?

Description is short (three sentences) but lacks parameter details, leaving gaps. It could be more concise by including param info without adding length. Every sentence earns its place but doesn't cover all necessary info.

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 3 parameters, 0% schema coverage, and no output schema, the description is incomplete. It does not specify return values (e.g., does it return the updated customer?), nor validate id format. A mutation tool needs more detail for correct 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 coverage is 0% (no param descriptions in schema). Description only explains 'mode' parameter (enum values behavior). Does not describe 'id' (presumably customer ID) or 'note' (text to add). Agents get no extra meaning for these critical parameters beyond schema field names.

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 'Add a note to a customer' with specific verb and resource. It distinguishes from sibling 'shopify_add_order_note' by targeting customers, and explains two modes (append, replace) with concrete behavior.

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 on when to use append vs replace, including performance implication (extra read query). Does not compare with alternative tools like update_customer, but context from sibling names makes usage clear.

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