Skip to main content
Glama

List customers

kickserv_list_customers
Read-only

List or search customers, 30 per page. Every filter is an exact match on that field. Use only to keep the response small. Kickserv: GET /{account}/customers.xml.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoExact customer name.
onlyNoComma-separated list of columns to return, e.g. `customer_number,name`. Kickserv recommends this: it makes responses much smaller and faster.
pageNoPage number (Kickserv returns 30 records per page). Omit for page 1.
includeNoRelated data to embed: contacts, jobs, tasks, notes, tax_entity, custom_field_assignments.
billing_cityNoBilling city.
phone_numberNoExact phone number, e.g. 800-555-1212.
service_cityNoService city.
billing_stateNoBilling state.
email_addressNoExact email address.
service_stateNoService state (2-letter abbreviation).
customer_numberNoCustomer number.
service_zip_codeNoService ZIP (full zip+4 if the record has one).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=true), yet the description adds real behavioral context: a 30-per-page pagination size, the fact that every filter is an exact match, and the response-size benefit of `only`. It stops short of stating total-count behavior or the 10,000-page cap, so it is not exhaustive, but it meaningfully exceeds the annotations.

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?

Four tight sentences, front-loaded with the core purpose and pagination fact before the tips. Every sentence carries signal; only the trailing endpoint reference ('GET /{account}/customers.xml') is mildly redundant for an agent, preventing a 5.

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 no output schema and 12 optional params, the description supplies the essentials an agent needs: collection intent, page size, exact-match filtering, and a response-slimming lever. Acceptable embedding details like `include` are left to the schema, which is reasonable given its full coverage.

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 description coverage is 100%, so baseline is 3, but the description goes slightly beyond the per-field docs by generalizing 'Every filter is an exact match on that field' across all 12 params and explaining the payoff of `only`. This reinforces semantics the individual schema blurbs state piecemeal.

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?

The description opens with a specific verb+resource, 'List or search customers', which clearly indicates a collection read vs. a single-record read. However, it never names the distinguishing sibling (kickserv_get_customer for a single lookup), so the differentiation from siblings is only implied by the plural noun.

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?

It offers one concrete usage tip ('Use `only` to keep the response small') and states that filters are exact matches, which is operationally useful. But it never says when to reach for this tool instead of kickserv_get_customer or kickserv_list_customer_jobs, and gives no exclusions or prerequisites, leaving most routing to inference.

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.