woo_add_order_note

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

No annotations exist, so the description must fully inform about behavior. It does not disclose side effects (e.g., whether this sends notifications, if notes are editable/removable, or what the response contains). The 'customer_note' parameter implications are not explained.

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, clear sentence. It is concise but could benefit from a brief expansion to cover key nuances without becoming verbose.

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 mutation tool with no output schema and three parameters, the description lacks information about return values, success indicators, or error scenarios. It is insufficient for an agent to fully understand the tool's interaction.

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%, and each parameter has a description. The tool description adds nothing beyond the schema, so it provides baseline value (score 3). No additional syntax or constraints are clarified.

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 'Add a note to an order' clearly states the action and object. However, it omits that the note can be a customer-facing or internal note, which is indicated by the 'customer_note' boolean parameter. This nuance is missing.

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?

No guidance is provided on when to use this tool versus alternatives. For example, there is a sibling tool 'woo_get_order_notes' for retrieving notes, but no differentiation is made. The description does not mention prerequisites or context.

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