Skip to main content
Glama
@cmssy/mcp-server

@cmssy/mcp-server

Official

List customers

list_customers
Read-only

Retrieve customer accounts that sign in to your site with status, verification, last login, company role, price list and order stats; filter by status, company or email search.

Instructions

List the customers - accounts that sign in to the user's site (records of an accounts model), with status, verification, last login, their company, companyRole (the effective company role: admin or buyer in v1, null without a company), effectivePriceList (the price list that prices them, source MEMBER or COMPANY; null = catalogue prices) and orderStats (non-canceled order count, last order date, and net spend = paid minus refunded, in minor units, one entry per currency; null when the caller may not view orders). Not the team: those are list_team. Read-only; filter by model, status, company or an identity search; newest first. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_customers"
  }
}

Input Schema

NameRequiredDescriptionDefault
skipNoHow many rows to skip, at most 10000; page past that with cursor
limitNo
cursorNonextCursor from the previous page. The page continues after it in the same filter and sort; leave the skip/offset at 0 when you pass it
searchNoCase-insensitive match against the sign-in identity (email)
statusNoFilter by account status
modelIdNoOnly customers of this accounts model, by id or slug (from list_models)
companyIdNoOnly customers linked to this company record

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.146.2
    • addedInput schema / properties / cursor
      Added value: +{
      +  "description": "nextCursor from the previous page. The page continues after it in the same filter and sort; leave the skip/offset at 0 when you pass it",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / skip / description
      Added value: +"How many rows to skip, at most 10000; page past that with cursor"
    • changedInput schema / properties / skip / maximum
      Previous value: -9007199254740991New value: +10000
  2. Addedv0.73.2

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the readOnlyHint/destructiveHint annotations, it discloses the default ordering (newest first), a permission-dependent field behavior (orderStats is null when the caller may not view orders), and null semantics for companyRole and effectivePriceList. It also spells out non-obvious pagination mechanics, including the hasMore/nextCursor/offset fallback and the 10000-row narrowing rule, which is exactly the kind of behavior an agent would otherwise get wrong.

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?

The core identity and scope are front-loaded, and the long field enumeration is dense but each item carries semantic value (null meanings, unit definitions, source enums). The result is a run-on sentence that could be broken into a scope sentence and a pagination sentence for faster scanning.

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?

With no output schema, the description takes on the burden of describing return fields and does so, including units (minor units), currency granularity, and null conditions. Combined with the pagination contract and the sibling disambiguation, 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.

Parameters4/5

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

Schema coverage is 86%, so the baseline is 3; the description adds real meaning on top by characterizing search as an identity (email) search, tying modelId to an accounts model, and framing the cursor/offset interaction that the schema only hints at. The remaining gap is minor, since individual parameter descriptions already carry most of the detail.

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 gives a specific verb and resource and then defines the resource in domain terms ("accounts that sign in to the user's site (records of an accounts model)"), which an agent cannot get from the name alone. It also explicitly disambiguates from the nearest look-alike sibling: "Not the team: those are list_team."

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?

It states the read-only nature, the available filter axes (model, status, company, identity search), the default sort (newest first), and names list_team as the tool to use instead for team members. It stops short of stating positive when-to-use conditions (e.g. when to reach for this over a generic records listing), so it is strong but not exhaustive.

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