Skip to main content
Glama

woo_list_orders

Retrieve WooCommerce orders with filters for status, customer, and date range, plus pagination, to review store sales or manage fulfillment.

Instructions

List WooCommerce orders (slim)

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "site": "<site>"
    },
    "name": "woo_list_orders"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default 1)
siteYesSite id (see list_sites)
afterNoOnly orders created after this date (YYYY-MM-DD). Not combinable with before: before wins
beforeNoOnly orders created before this date (YYYY-MM-DD)
statusNoOrder status: any (default), pending, processing, on-hold, completed, cancelled, refunded, failed
customerNoCustomer (user) ID
per_pageNoOrders per page (default 20, -1 for all)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 schema fields changedv3.14.0
    • changedInput schema / properties / after / description
      Previous value: -"Orders after date (YYYY-MM-DD)"New value: +"Only orders created after this date (YYYY-MM-DD). Not combinable with before: before wins"
    • changedInput schema / properties / before / description
      Previous value: -"Orders before date (YYYY-MM-DD)"New value: +"Only orders created before this date (YYYY-MM-DD)"
    • changedInput schema / properties / customer / description
      Previous value: -"Customer ID"New value: +"Customer (user) ID"
    • changedInput schema / properties / customer / type
      Previous value: -"number"New value: +"integer"
    • removedInput schema / properties / page / default
      Removed value: -1
    • addedInput schema / properties / page / description
      Added value: +"Page number (default 1)"
    • changedInput schema / properties / page / type
      Previous value: -"number"New value: +"integer"
    • removedInput schema / properties / per_page / default
      Removed value: -20
    • addedInput schema / properties / per_page / description
      Added value: +"Orders per page (default 20, -1 for all)"
    • changedInput schema / properties / per_page / type
      Previous value: -"number"New value: +"integer"
    • removedInput schema / properties / product
      Removed value: -{
      -  "description": "Product ID",
      -  "type": "number"
      -}
    • removedInput schema / properties / status / default
      Removed value: -"any"
    • addedInput schema / properties / status / description
      Added value: +"Order status: any (default), pending, processing, on-hold, completed, cancelled, refunded, failed"
  2. Changed2 schema fields changedv3.4.0
    • addedInput schema / properties / site
      Added value: +{
      +  "description": "Site id (see list_sites)",
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "site"
      +]
  3. First observedv2.0.0

TDQS

C2.5/5.0
Behavior2/5

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

No annotations exist, so the description carries the full burden and largely drops it. It doesn't explain what "slim" omits from order records, how pagination behaves beyond the schema's default, what happens with per_page=-1, or whether reads are safe/idempotent. Naming it a list makes read-only behavior plausible but not stated.

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

Conciseness3/5

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

At five words it is undeniably front-loaded and waste-free, but that brevity crosses into under-specification: the one qualifier it does include, "slim", is opaque rather than informative.

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

Completeness2/5

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

For a 7-parameter tool with no annotations and no output schema, the description leaves too much to be inferred. The undefined "slim" payload shape and the absence of any return-format hint are real gaps for a listing tool whose output the agent must interpret.

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%, including the notable after/before precedence rule ("before wins"), so the schema already does the semantic work. The description adds nothing on top, which is the baseline expectation rather than a failure.

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

Purpose3/5

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

"List WooCommerce orders" gives a clear verb and resource, so the basic purpose is readable. But "(slim)" is undefined jargon — it doesn't say whether slim means a reduced field set, a summary payload, or something else — and there is no differentiation from siblings like woo_get_customer_orders or woo_helper_list_invoice_orders, which plausibly overlap.

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?

There is no guidance on when to use this versus the other order-listing tools in the catalog, nor any prerequisites (site id required, per_page -1 for all). The agent must infer everything from the name alone.

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

Deploy Server

Other Tools