create_order_note

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

The description adds meaningful behavioral context beyond the minimal annotations. It discloses that the default is a private admin note and that customer_note=true triggers an email notification to the customer. This goes beyond the schema and annotations to inform the agent of side effects.

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 extremely concise, consisting of three sentences that are all informative. It front-loads the core action ('Add a note to an order') and immediately provides the key behavioral nuance without any fluff.

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 simple create tool, the description covers the core behavior and the important parameter nuance. It does not explain the optional 'fields' parameter, but the schema fully documents it. The absence of an output schema is not a significant gap here.

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 100%, so the baseline is 3. The description adds extra semantics for the customer_note parameter by explaining the email notification and the default private note behavior, providing value beyond the schema descriptions.

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: 'Add a note to an order.' This is a specific verb and resource, and it distinguishes itself from sibling tools like list_order_notes and delete_order_note by focusing on the creation aspect.

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 implies usage context by stating 'Add a note to an order' and explains the behavior of customer_note, but it does not explicitly mention when to use this tool versus alternatives or provide exclusions. The guidance is clear but not exhaustive.

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