Skip to main content
Glama

list_customers

Read-only

Retrieve customers—organisations projects are attached to and billed for—filtered by name, active status, or managers. Use it to find a customer's id or name before creating or listing projects.

Instructions

List customers, the organisations projects are attached to and billed for. Use it to find a customer's id or name before create_project or list_projects(customer=...); use get_customer for one customer's detail. Read-only. Filter by name fragment, active status, or managers given by name, email or id. An empty result is an empty list, not an error.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoHow many objects to return. Upstream maximum is 1000.
queryNoKeep only customers whose name contains this text.
offsetNoHow many objects to skip, for the next page.
managersNoKeep only customers managed by these people, by name, email or id.
is_activeNoKeep only active, or only inactive, customers.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNoSet when the answer is worth a word of explanation.
countYesHow many objects match the filters upstream, beyond this page.
itemsYesThe objects.
returnedYesHow many objects this answer carries.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered; the description reinforces read-only and adds genuinely non-obvious behavior: an empty result is an empty list, not an error. It stops short of describing pagination behavior beyond what limit/offset imply.

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?

Front-loaded with purpose, then usage routing, then filters, then error semantics. Every clause carries distinct information; no filler or repetition of the tool name.

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?

An output schema exists so return values need no explanation, and the description covers the remaining gaps: alternatives, filter scope, read-only nature, and empty-result semantics. Nothing needed to call or route this tool is missing.

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 schema already documents all five parameters. The description summarizes the filter axes (name fragment, active status, managers by name/email/id), which mirrors rather than extends the schema — correct baseline of 3.

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?

States a specific verb (list) plus resource (customers) and even clarifies the domain model — organisations that projects are attached to and billed for. It distinguishes itself from get_customer (single detail) and from list_projects, so an agent can separate it from siblings without opening a schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit workflow trigger ('find a customer's id or name before create_project or list_projects(customer=...)') and names the alternative for single-record retrieval ('use get_customer for one customer's detail'). When-to-use and when-not-to-use are both present.

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