Skip to main content
Glama
AmitGurbani

mcp-server-woocommerce

by AmitGurbani

list_order_notes

Read-only

Retrieve all notes for an order, including private admin notes and customer-visible notes. Use the fields parameter to request only needed fields.

Instructions

List all notes for an order. Includes both private admin notes and customer-visible notes. Use fields param to request only needed fields.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
fieldsNoComma-separated fields to return (default: id,author,date_created,note,customer_note)
order_idYesOrder ID
Behavior4/5

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

Annotations provide readOnlyHint=true, so the read-only nature is already known. The description adds useful behavioral context by specifying that both private and customer-visible notes are returned, which is not derivable from annotations. It also hints at response optimization via fields, though no pagination or sorting details are disclosed.

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?

The description is two short sentences, front-loaded with the core purpose. Every sentence adds value: the first states what and the second provides usage guidance. No filler or repetition.

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

Completeness5/5

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

Given the tool's simplicity (2 params, no output schema), the description covers the essential context: what it lists, what note types are included, and how to request only needed fields. This is sufficient for an agent to select and invoke the tool correctly.

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 coverage is 100%, so the parameters are already well-documented (order_id, fields with defaults). The description's mention of using the fields parameter adds marginal emphasis but does not introduce new semantic information beyond the schema. Baseline 3 is appropriate.

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

Purpose5/5

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

The description clearly states the tool's function: 'List all notes for an order.' It also adds specificity by noting it includes both private admin notes and customer-visible notes, which distinguishes it from note creation/deletion tools and clarifies scope.

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

Usage Guidelines4/5

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

The description implies when to use the tool (when you need an order's notes) and gives guidance on using the 'fields' parameter to limit response size. It does not explicitly state when not to use it or mention alternatives, but the context is clear enough given sibling tools.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/AmitGurbani/mcp-server-woocommerce'

If you have feedback or need assistance with the MCP directory API, please join our Discord server