Skip to main content
Glama

Aryeo MCP by usefulapi

List customers

aryeo_list_customers
Read-only

List your customers (the agents, brokerages and teams who order from you) with contact details and balances. Filter by name, email, email domain, phone or search text. GET /customers.

Input Schema

NameRequiredDescriptionDefault
nameNoCustomers with this name.
pageNoPage number, from 1 (default 1). Pass the previous reply's next_page.
sortNoComma-separated sort fields; a leading - sorts descending. Default -created_at.
emailNoCustomers with this exact email address.
phoneNoCustomers with this phone number.
searchNoCustomers matching this text.
includeNoComma-separated relations to expand. Example: users. An unknown value makes Aryeo reply with the allowed list.
per_pageNoResults per page, 1-100 (Aryeo default 25).
email_domainNoCustomers whose email is on this domain, e.g. gmail.com.
customer_team_idsNoComma-separated customer team ids.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds only the endpoint path (GET /customers) and the shape of returned data at a high level; it says nothing about pagination defaults, result limits, or whether balances are computed live.

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?

Two tight sentences front-load the operation, entity definition, and filterable fields. The trailing 'GET /customers' is marginal but aids cross-referencing with API docs.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With ten optional parameters and no output schema, the description leaves gaps an agent must close from the schema alone: pagination flow (use next_page), default sort (-created_at), the `include` expansion, and the max page size. Adequate but not complete for a paged list tool of this complexity.

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 all ten parameters, including `include`, `sort`, `per_page`, and `customer_team_ids`, are already documented with formats and defaults. The description only echoes five of the filter fields, adding no format or precedence detail beyond the schema; baseline 3 applies.

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 ('List your customers') and even defines the domain entity in parentheses (agents, brokerages, teams who order from you), plus what fields come back (contact details, balances). It doesn't explicitly contrast with aryeo_create_customer, but the list/create distinction is self-evident from the verb.

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 enumeration of filter fields implies how to narrow results, but there is no explicit when-to-use guidance, no statement of when to prefer `search` over `name`/`email`, and no mention of how to page through results or when to use this versus listing orders. Usage is inferable but not spelled out.

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.