Skip to main content
Glama

List Customers

listCustomers
Read-onlyIdempotent

List Customers

Retrieve project customers with optional search, tag, exact email or phone, sort, facet filters, and calendar bounds on a chosen datetime column. phone matches E.164 when the value is parseable. To create or match by contact without an id, use POST /customers (email first, then phone).

List endpoints are paginated. Use the page and limit query parameters to paginate through results (at most 30 records per page). Check the pagination object in the response (current_page, last_page, total) to determine if more pages exist and whether to continue fetching.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNoSearch string matching customer first name, last name, full name, email, or company. Case-insensitive partial match. At most 100 characters.
pageNoWhich page of results to return (1 is the first page). Omit this field or use 1 for the first page. Accepts minimum 1.
emailNoEmail address for the person or customer.
limitNoMaximum number of records to return. Accepts an integer from 1 to 30.
phoneNoExact phone filter. Normalized to E.164 when parseable (same helper as create/upsert), then matched on phone_e164. Unparseable values match the raw phone column.
filterNoCustomer list facet aligned with console filters (excluding archived unless requested).
date_toNoInclusive upper calendar date (YYYY-MM-DD) for the column chosen by date_key; must be on or after date_from when both bounds are provided.
date_keyNoCustomer datetime column paired with date_from and date_to (defaults to created_at when omitted).
sort_dirNoSort direction: asc or desc.
sort_keyNoCustomer field to sort by.
tag_slugNoURL-friendly identifier for the customer tag.
date_fromNoInclusive lower calendar date (YYYY-MM-DD) for the column chosen by date_key, defaulting to created_at when date_key is omitted.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
codeNoShort code or application-level status code for this resource.
dataNoResponse payload for the request.
successNoIndicates whether the request completed successfully.
paginationNoPagination metadata for list responses.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / phone
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Exact phone filter. Normalized to E.164 when parseable (same helper as create/upsert), then matched on phone_e164. Unparseable values match the raw phone column."
      +}
  2. First observed

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already establish readOnly, idempotent, non-destructive and openWorld, so the safety profile is covered. The description adds genuinely new behavior: the 30-records-per-page cap, the response pagination fields (current_page, last_page, total) for deciding whether to fetch more, and phone normalization to E.164 with a raw-column fallback for unparseable values.

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?

Front-loads the purpose, then the routing alternative, then the pagination contract, with no filler. The leading "List Customers" line duplicates the title and is the only wasted element.

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?

With rich annotations and an output schema present, the description need not explain return values, and it still covers the pagination mechanics and the create/match escape hatch. What's missing is only comparison to sibling list/get tools over the same resource.

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 the baseline is 3. The description's parameter-level additions (phone E.164 normalization, the 30-record page limit, calendar bounds on a chosen datetime column) largely restate what the schema already documents for phone, limit, date_key, date_from and date_to, adding little beyond it.

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?

States a specific verb and resource ("Retrieve project customers") and enumerates the filter/sort dimensions available, which distinguishes it from single-record siblings like getCustomer. It does not name a list-vs-get alternative explicitly, so it stops short of full sibling differentiation.

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?

Gives an explicit routing rule for a related case: "To create or match by contact without an id, use POST /customers (email first, then phone)," and prescribes the pagination workflow (use page/limit, inspect the pagination object). It doesn't say when to prefer listCustomers over getCustomer or listCustomerCharges, so the exclusion set is incomplete.

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