Skip to main content
Glama

List customers

wp_wc_list_customers
Read-onlyIdempotent

WooCommerce: list registered users with the role customer, with id, email, name and order_count, plus total for paging. Guest orders without an account are not included; wp_list_users lists users of every role. Read-only; needs manage_woocommerce. Requires WooCommerce. Forwarded by AlphaBridge Connect to the one site this connection reaches.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, starting at 1. Default 1.
searchNoWordPress user search, which picks the fields by the term: with "@" the email, starting with http:// or https:// the URL (on a large multisite network the general fields instead), a number the login (or the exact id), otherwise login, email, URL, nicename and display name; matched anywhere in the field. Omitted: all customers.
per_pageNoCustomers per page, 1 to 100. Default 20.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / page / description
      Added value: +"Page number, starting at 1. Default 1."
    • addedInput schema / properties / per_page / description
      Added value: +"Customers per page, 1 to 100. Default 20."
    • addedInput schema / properties / search / description
      Added value: +"WordPress user search, which picks the fields by the term: with \"@\" the email, starting with http:// or https:// the URL (on a large multisite network the general fields instead), a number the login (or the exact id), otherwise login, email, URL, nicename and display name; matched anywhere in the field. Omitted: all customers."
  2. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already declare readOnlyHint/idempotentHint/non-destructive, and the description layers on genuinely additive facts the schema does not carry: the manage_woocommerce capability requirement, the WooCommerce dependency, and the forwarding behavior of AlphaBridge Connect to a single reachable site (consistent with openWorldHint=false). It also discloses that guest-only customers are absent, which affects result interpretation.

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?

Front-loaded with 'WooCommerce: list registered users with the role customer', then return shape, then exclusions/alternatives, then prerequisites. Four short clauses, each carrying distinct information; no filler.

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?

No output schema exists, so the description compensates by enumerating the return fields and noting 'total' for paging. Combined with the annotations for safety, the stated auth/plugin prerequisites, and the sibling boundary, an agent has everything needed to call this 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 description coverage is 100% and the search parameter is documented exhaustively (term-dependent field selection, substring matching), so the schema is doing the heavy lifting. The description adds nothing about parameter syntax or interaction, only the returned fields — baseline 3 applies.

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?

States a specific verb and resource with a precise scope: 'list registered users with the role customer', then enumerates the returned fields (id, email, name, order_count, total). It also carves out a boundary against the nearest sibling (wp_list_users lists every role), so an agent can pick between them without opening either schema.

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?

Names the alternative (wp_list_users) and the exact condition that distinguishes it, plus a concrete when-not: 'Guest orders without an account are not included'. It stops short of an explicit 'use this when you need customer/order-attributed users' directive, but the routing information is clear.

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