Skip to main content
Glama

Add Order Note

woo_add_order_note

Add a note to a WooCommerce order. Notes can be private (admin only) or customer-visible (sent via email).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesOrder ID
noteYesNote content
site_idNoSite ID to target (optional if you have only one connected site)
customer_noteNoIf true, note is visible to customer and emailed (default: false, private note)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already establish the safety profile (non-readOnly, non-destructive, non-idempotent, open world), but the description adds real context the annotations don't carry: the private/admin-only vs customer-visible distinction and, critically, that customer notes are emailed. That undisclosed side effect is a genuine behavioral disclosure.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences, zero waste, and the core action is front-loaded before the privacy/visibility nuance. Nothing to trim.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple mutation tool with no output schema and full schema coverage, the description covers the action and its key side effect (email). The only minor gap is the absence of any note about the response or permission requirements.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all four parameters (including customer_note's default and semantics) are already documented in the schema. The description's privacy/email contrast mirrors the schema's own customer_note documentation, adding no syntax or meaning beyond it. Baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (add) and resource (note to a WooCommerce order), so an agent knows exactly what it does. It doesn't explicitly distinguish itself from the read-side sibling woo_list_order_notes, but the verb+resource is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

No when-to-use guidance at all: it never says when to add a note versus listing existing ones (woo_list_order_notes), nor mentions prerequisites like which order states warrant a note. The email side effect is described, but that is behavior, not usage routing.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources