Skip to main content
Glama

Tradify MCP Server and API by Cotlet

List customers

list_customers
Read-onlyIdempotent

Customer profiles with contact details and sites. Lists customers by name with contact, email (may be a comma list), phone, mobile, physical address and sites. search matches name, contact, email or phone, so use it to find the customer_id before creating a job or quote. archived lists archived customers instead. Pass next_cursor back as cursor.

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
limitNo
cursorNonext_cursor from the previous call.
searchNoMatches name, contact, email or phone.
archivedNoList archived customers instead.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description adds useful behavior beyond that: pagination via next_cursor, the matching fields for search, and the note that email may be a comma-separated list. It omits ordering guarantees and page-size behavior, keeping it just shy of a 5.

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 returned resource and fields, then packs search usage, archived behavior, and cursor semantics into tight sentences. Dense but no filler; slightly cramped rather than bloated.

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?

No output schema exists, so the description carries the burden of describing return contents, which it does (contact, email, phone, mobile, address, sites). Pagination and search semantics are covered; ordering and empty-result behavior are not, a minor gap for a list tool.

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 75% and the description reinforces the meaning of `search` (matches name/contact/email/phone), `archived` (lists archived instead), and `cursor` (pass next_cursor back). Only `limit` is left to the schema, which is self-evident, so the description adds real value on the non-obvious params.

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 (lists) and resource (customers) plus the returned fields (contact, email, phone, mobile, address, sites). The opening sentence establishes exactly what the tool produces, distinguishing it from mutation siblings like create_customer and unrelated list_* tools.

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?

Explicitly says to use `search` to find a customer_id before creating a job or quote, and clarifies that `archived` switches to archived customers. It gives clear positive usage context but does not explicitly exclude or contrast against all sibling list tools (e.g., list_quotes/list_jobs), so it stops short of a 5.

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.