Skip to main content
Glama

Shopify

by io.github.pipeworx-io
OverviewDiscussionsAdmin

Shopify List Customers

shopify_list_customers
Read-onlyIdempotent

List customers in a Shopify store (up to 250 per call). Returns customer IDs, names, emails, order counts, and total spend. Requires Admin API access token and shop domain.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
_shopYesShop domain (e.g., mystore.myshopify.com)
limitNoNumber of customers to return (max 250, default 50)
_apiKeyYesShopify Admin API access token

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
customersNoList of customers

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "customers": {
+      "description": "List of customers",
+      "items": {
+        "properties": {
+          "created_at": {
+            "description": "Creation timestamp",
+            "type": "string"
+          },
+          "email": {
+            "description": "Customer email",
+            "type": "string"
+          },
+          "first_name": {
+            "description": "Customer first name",
+            "type": "string"
+          },
+          "id": {
+            "description": "Customer ID",
+            "type": "number"
+          },
+          "last_name": {
+            "description": "Customer last name",
+            "type": "string"
+          },
+          "orders_count": {
+            "description": "Total orders placed",
+            "type": "number"
+          },
+          "state": {
+            "description": "Customer state",
+            "type": "string"
+          },
+          "total_spent": {
+            "description": "Total amount spent",
+            "type": "string"
+          },
+          "updated_at": {
+            "description": "Last update timestamp",
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}
  2. Changed1 schema field changed
    • addedInput schema / examples
      Added value: +[
+  {
+    "_apiKey": "your-shopify-api-key",
+    "_shop": "mystore.myshopify.com"
+  },
+  {
+    "_apiKey": "your-shopify-api-key",
+    "_shop": "mystore.myshopify.com",
+    "limit": 150
+  }
+]
  3. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations declare readOnlyHint, idempotentHint, and destructiveHint false, indicating a safe, read-only operation. The description adds valuable behavioral context: the 250-per-call limit and the specific fields returned. It 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 sentences, front-loaded with the main action and limit, followed by return fields and requirements. Every sentence adds value; no fluff.

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?

For a simple list tool with rich annotations and an output schema, the description is largely complete. It covers the action, constraints, return fields, and auth. A minor gap is lack of pagination details beyond the per-call limit, but this is acceptable given the tool's simplicity.

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 coverage is 100%, so parameters are already well-documented. The description does not add new parameter details beyond restating requirements. It implicitly mentions the 'limit' parameter via the 250 cap, but no syntax or defaults.

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'), the resource ('customers in a Shopify store'), and includes specific constraints ('up to 250 per call') and return fields ('IDs, names, emails, order counts, and total spend'). This distinguishes it from sibling tools like shopify_list_orders and shopify_list_products.

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?

The description specifies prerequisites ('Admin API access token and shop domain'), but does not explicitly compare with sibling tools or state when not to use it. However, the context of sibling names makes the usage clear enough.

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

All Shopify toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources