Skip to main content
Glama
benpalmer1

Gorgias MCP Server

by benpalmer1

List Customers

gorgias_list_customers
Read-only

List customers with pagination and filters for email, name, language, timezone, channel, or external ID.

Instructions

GET /api/customers — List customers (paginated, default order: created_datetime:desc). Supports filtering by email, external ID, name, language, timezone, view, channel type, and channel address.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoFilter by the full name of the customer.
emailNoFilter by the primary email address of the customer.
limitNoMaximum number of customers to return per page (default: 30, max: 100).
cursorNoPagination cursor from a previous response. Omit to retrieve the first page.
view_idNoFilter by saved view ID.
languageNoFilter by the customer's preferred language (ISO 639-1 format, e.g. 'fr', 'en').
order_byNoAttribute used to order customers (default: 'created_datetime:desc').
timezoneNoFilter by the customer's preferred timezone (IANA timezone name, e.g. 'America/New_York').
external_idNoFilter by the customer's ID in a foreign system (Stripe, Aircall, etc.).
channel_typeNoFilter by customer channel type (e.g. 'email', 'phone', 'sms', 'chat', 'facebook').
channel_addressNoFilter by exact channel address. Typically used together with channel_type.
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the agent knows it is a safe read operation. The description adds behavioral context by mentioning pagination and default ordering (created_datetime:desc), which goes beyond the annotations. It doesn't contradict any annotation.

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?

The description is a single, front-loaded sentence that efficiently conveys the endpoint, purpose, and key filter capabilities. Every word serves a purpose, and there is no redundancy or unnecessary detail.

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?

The description covers the core purpose, pagination, and default ordering. While there is no output schema to clarify return values, the tool name and description imply a list of customers. The schema handles parameter details, and the description sufficiently orients the agent for a read-only list operation.

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%, and the input schema already describes all 11 parameters clearly (e.g., filters, limit, cursor, order_by). The description's list of filters adds no new semantics beyond what the schema provides, so the baseline score of 3 is appropriate.

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 clearly states the tool's action ('List customers') with the API endpoint, and the name reinforces this. It explicitly distinguishes from single-customer retrieval (gorgias_get_customer) and mutation tools by focusing on listing with pagination and filtering.

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 description implies usage for retrieving multiple customers and mentions supported filters, but it does not explicitly state when to use this tool versus alternatives (e.g., for a single customer use gorgias_get_customer) or provide any exclusion criteria. The context is sufficient but not fully explicit.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/benpalmer1/Gorgias-MCP-Server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server