wp_add_order_note

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

With no annotations, the description carries the full burden of behavioral disclosure. It states that the note can be admin-visible or customer-visible, but it does not explain side effects, whether the note is appended to order history, permission requirements, or what happens if the order does not exist. This is minimal for a mutation tool.

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, tightly written sentence with no filler or redundant information. It front-loads the action and the core distinction, making it easy for an agent to parse quickly.

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 tool is simple and the schema covers all parameters, but there is no output schema and no annotations. The description explains the core purpose and visibility nuance, yet it omits expected return behavior or error conditions. It is minimally viable but leaves some operational context to inference.

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 input schema already documents all three parameters with 100% coverage, so the description does not need to repeat them. The phrase 'admin or customer-visible' adds a small amount of semantic context for the customer_note parameter, but the description does not otherwise deepen parameter understanding 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 specific action ('Add'), the resource ('note to a WooCommerce order'), and the key distinction of admin versus customer-visible notes. It is unambiguous and differentiates this tool from related order tools like wp_get_order or wp_update_order.

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 the tool is used when you need to add a note to an order, but it provides no explicit guidance on when to choose this tool over alternatives, nor does it mention prerequisites such as the order existing. No when-not-to-use context is given.

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