Skip to main content
Glama

WooCommerce: List customers

woocommerce_list_customers
Read-only

List paginated WooCommerce customers with email, order count, and total spent to enable site-specific customer analysis and filtering.

Instructions

[UNIFIED] List WooCommerce customers. Returns paginated customer list with email, orders count, and total spent.

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": "woocommerce_list_customers"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNo
roleNo
siteYes
emailNo
searchNo
per_pageNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.14.0
  2. Removedv3.13.1
  3. First observedv3.4.0

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the description earns credit for adding the return shape (email, orders count, total spent) and confirming pagination. It stops short of explaining how filters combine, whether results are sorted, or what an empty result looks like — useful context for a 6-parameter listing call.

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

Conciseness4/5

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

Two tight sentences with the operation stated first and the return payload second; nothing is wasted. The only dead weight is the unexplained "[UNIFIED]" tag.

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?

With six parameters at 0% schema coverage and no output schema, the description should explain the filtering parameters and the pagination contract. It covers the return fields but leaves the input semantics largely unexplained, which is a meaningful gap for a list tool with role/email/search filters.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must carry parameter meaning, but it only gestures at pagination ("paginated customer list"). The role, email, search, and site parameters — including whether email/search are exact or partial matches — are left entirely undocumented in both schema and description.

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?

The description uses a specific verb and resource ("List WooCommerce customers") and states the returned fields, so the operation is unambiguous. It does not, however, differentiate this from sibling reads like woocommerce_get_customer or create_customer, and the "[UNIFIED]" prefix conveys nothing to an agent.

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 list tool versus woocommerce_get_customer for a single record, nor when to reach for report tools like woocommerce_get_customer_report. No prerequisites, exclusions, or filtering scenarios are described.

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