Skip to main content
Glama

Woo List Orders

woo_list_orders
Read-onlyIdempotent

List WooCommerce orders, optionally filtered by status (pending, processing, on-hold, completed, cancelled, refunded, failed). Returns order IDs, totals, customer info, and line items.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default 1)
statusNoFilter by status: any, pending, processing, on-hold, completed, cancelled, refunded, failed
_apiKeyYesWooCommerce consumer key
per_pageNoResults per page (max 100, default 20)
_storeUrlYesStore URL (e.g., https://mystore.com)
_apiSecretYesWooCommerce consumer secret

Output Schema

NameRequiredDescriptionDefault
countYesNumber of items returned.
itemsYesArray of orders from WooCommerce store

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "properties": {
      +    "count": {
      +      "description": "Number of items returned.",
      +      "type": "integer"
      +    },
      +    "items": {
      +      "description": "Array of orders from WooCommerce store",
      +      "items": {
      +        "properties": {
      +          "cart_tax": {
      +            "description": "Cart tax",
      +            "type": "string"
      +          },
      +          "created_via": {
      +            "description": "Creation method",
      +            "type": "string"
      +          },
      +          "currency": {
      +            "description": "Currency code",
      +            "type": "string"
      +          },
      +          "customer_id": {
      +            "description": "Customer ID",
      +            "type": "number"
      +          },
      +          "date_created": {
      +            "description": "Creation date in ISO format",
      +            "type": "string"
      +          },
      +          "date_modified": {
      +            "description": "Last modified date in ISO format",
      +            "type": "string"
      +          },
      +          "discount_tax": {
      +            "description": "Discount tax",
      +            "type": "string"
      +          },
      +          "discount_total": {
      +            "description": "Discount total",
      +            "type": "string"
      +          },
      +          "id": {
      +            "description": "Order ID",
      +            "type": "number"
      +          },
      +          "number": {
      +            "description": "Order number",
      +            "type": "string"
      +          },
      +          "order_key": {
      +            "description": "Order key",
      +            "type": "string"
      +          },
      +          "parent_id": {
      +            "description": "Parent order ID",
      +            "type": "number"
      +          },
      +          "shipping_tax": {
      +            "description": "Shipping tax",
      +            "type": "string"
      +          },
      +          "shipping_total": {
      +            "description": "Shipping total",
      +            "type": "string"
      +          },
      +          "status": {
      +            "description": "Order status",
      +            "type": "string"
      +          },
      +          "total": {
      +            "description": "Order total",
      +            "type": "string"
      +          },
      +          "total_tax": {
      +            "description": "Total tax",
      +            "type": "string"
      +          },
      +          "version": {
      +            "description": "Order version",
      +            "type": "string"
      +          }
      +        },
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "required": [
      +    "items",
      +    "count"
      +  ],
      +  "type": "object"
      +}
  2. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
      +  {
      +    "_apiKey": "your-woocommerce-api-key",
      +    "_apiSecret": "your-woocommerce-api-secret",
      +    "_storeUrl": "https://mystore.com"
      +  },
      +  {
      +    "_apiKey": "your-woocommerce-api-key",
      +    "_apiSecret": "your-woocommerce-api-secret",
      +    "_storeUrl": "https://mystore.com",
      +    "per_page": 50,
      +    "status": "completed"
      +  }
      +]
  3. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, indicating safe reads. The description adds value by specifying return fields (order IDs, totals, customer info, line items) beyond the annotations. No contradictions.

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 a single, well-structured sentence that immediately conveys the tool's purpose and key features. Every word adds value, no redundancy.

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?

Given the existence of an output schema, the description does not need to detail return values beyond what it provides. It mentions filtering and key output fields. Could mention pagination, but overall sufficient for a list tool with good annotations.

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 parameters are documented in the schema. The description adds minimal parameter-level value beyond noting optional status filtering. Baseline of 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 verb ('List'), resource ('WooCommerce orders'), and optional filtering by status. It distinguishes from siblings like woo_get_order (single order) and woo_list_products (products).

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

Usage Guidelines3/5

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

The description mentions optional status filtering but does not provide explicit guidance on when to use this tool vs alternatives (e.g., woo_get_order for a specific order). The context signals list siblings but the description does not address them.

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.