wafle_orders_add_note

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

Given the minimal annotations (idempotentHint=false, destructiveHint=false), the description adds valuable side-effect context: notes appear in the timeline and customer-visible notes also appear on the order detail page and trigger email. This goes beyond the annotations, though it omits failure modes and idempotency consequences.

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 single, front-loaded sentence that covers purpose and key side effects efficiently. The minor inaccuracy in parameter naming slightly reduces its quality, but overall it is well-structured and concise.

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 main action and side effects, but it lacks a clear mapping to the actual boolean parameter name and does not mention return values or error conditions. It is adequate for basic understanding but leaves gaps that could affect 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?

The description references `customer=true` but the actual schema parameter is `customer_visible`, which is a misleading mismatch. It does clarify the effect of the flag, but the incorrect parameter name could lead to invocation errors. Other parameters (order_id, text) are not explained beyond 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's function: adding an internal or customer-visible note to an order, with specific side effects. This distinguishes it from sibling order tools like cancel, refund, or ship.

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?

It provides clear context on when to use the tool (whenever a note must be attached to an order) and explains the difference between internal and customer-visible notes. However, it does not explicitly exclude alternatives or mention prerequisites like the order existing.

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