Skip to main content
Glama

Woocommerce

by io.github.pipeworx-io
OverviewDiscussionsAdmin

Woo List Customers

woo_list_customers
Read-onlyIdempotent

List customers registered in a WooCommerce store. Returns customer IDs, names, emails, and order counts. Supports per_page (max 100) and page for pagination.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default 1)
_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 customers 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 customers from WooCommerce store",
+      "items": {
+        "properties": {
+          "billing": {
+            "description": "Billing address details",
+            "type": "object"
+          },
+          "date_created": {
+            "description": "Creation date in ISO format",
+            "type": "string"
+          },
+          "date_modified": {
+            "description": "Last modified date in ISO format",
+            "type": "string"
+          },
+          "email": {
+            "description": "Customer email address",
+            "type": "string"
+          },
+          "first_name": {
+            "description": "Customer first name",
+            "type": "string"
+          },
+          "id": {
+            "description": "Customer ID",
+            "type": "number"
+          },
+          "is_paying_customer": {
+            "description": "Whether customer is paying",
+            "type": "boolean"
+          },
+          "last_name": {
+            "description": "Customer last name",
+            "type": "string"
+          },
+          "role": {
+            "description": "Customer role",
+            "type": "string"
+          },
+          "shipping": {
+            "description": "Shipping address details",
+            "type": "object"
+          },
+          "username": {
+            "description": "Customer username",
+            "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"
+  }
+]
  3. First observed

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint, so the description's behavioral disclosure is minimal. It adds that the tool returns specific customer data and supports pagination, but does not contradict annotations.

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?

Two concise sentences. First sentence states purpose, second details returns and pagination. No fluff, front-loaded, and every sentence adds value.

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 presence of an output schema and annotations, the description covers the essential functionality (list customers, return fields, pagination). It lacks mention of filtering or authentication, but these are in schema and annotations. Very adequate for a simple list tool.

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 baseline is 3. The description adds that per_page has a max of 100 and page is for pagination, but these are already detailed in the schema. No additional meaning beyond schema.

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 action (list customers) and specifies the returned fields (IDs, names, emails, order counts). It distinguishes from sibling tools like woo_list_orders or woo_list_products by focusing on customers.

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 does not explicitly state when to use or not use this tool versus alternatives. It implies usage for retrieving customer lists and mentions pagination support, but lacks explicit context or exclusion criteria.

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

All Woocommerce toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources