Skip to main content
Glama
benpalmer1

Gorgias MCP Server

by benpalmer1

List Users

gorgias_list_users
Read-only

List Gorgias helpdesk users with cursor-based pagination. Filter by email, role, external ID, or search to retrieve specific user records.

Instructions

GET /api/users — List users with cursor-based pagination. Supports filtering by email, external ID, role, search term, and ordering.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailNoFilter by exact email address.
limitNoMaximum number of users to return per page (default: 30, max: 100)
rolesNoFilter by role names. Common values: 'admin', 'agent'.
cursorNoPagination cursor from a previous response (meta.next_cursor or meta.prev_cursor)
searchNoFree-text search against user name and email.
order_byNoSort order, e.g. 'name:asc', 'email:desc', 'created_datetime:desc'.
external_idNoFilter by external_id (foreign system identifier).
available_firstNoIf true, prioritise currently available users in the result order.
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, and the description adds valuable behavioral traits such as cursor-based pagination and the supported filter fields. It does not contradict annotations and provides useful context beyond the safety hints.

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, efficient sentence, front-loaded with the HTTP method and resource, and lists key capabilities without any filler. Every word earns its place.

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?

Given full schema coverage and annotations, the description provides a solid overview of the tool's purpose, pagination, and filters. However, with no output schema, it does not explicitly describe the response shape (e.g., paginated list with cursors), which is a minor gap.

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 baseline is 3. The description summarizes several filter parameters (email, external ID, role, search, ordering) but does not add syntax or semantics beyond the schema. Other params (limit, cursor, available_first) are only covered by the schema.

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 'GET /api/users — List users' with a specific verb and resource, and enumerates filtering and pagination capabilities, distinguishing it from user mutation tools and other 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?

The description implicitly conveys when to use the tool (whenever listing users with filters/pagination) but does not explicitly compare with alternatives like get_user for single-user retrieval. It provides clear context without exclusions.

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