Skip to main content
Glama

get_users

Look up one end user by email or external_id (404 USER_NOT_FOUND if absent), or list users newest first with total, filterable by signup_host / signup_credit_type_id. Costs 1 CRD (platform credit) per call, charged even when the call is then rejected (a 429 RATE_LIMITED costs nothing). Error results include request_id; quote it to support.

Input Schema

NameRequiredDescriptionDefault
emailNoLook up by email
limitNoResults per page (max 1000, default 100)
offsetNoPagination offset (default 0)
api_keyNoCred API key (optional if set via the x-api-key header)
project_idNoCred project ID (optional; the API key already identifies the project)
external_idNoLook up by external ID
signup_hostNoList only users who signed up from this host, e.g. app1.example.com
x402_paymentNoBase64 x402 PaymentPayload, only when a previous call failed with an x402 PaymentRequired because the account is out of CRD
signup_credit_type_idNoList only users attributed to this credit type

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior5/5

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

With no annotations provided, the description carries the full burden and does so well: it discloses a 1 CRD cost per call, that the charge applies even to rejected calls, the 429 RATE_LIMITED exception where nothing is charged, the 404 USER_NOT_FOUND outcome for missing lookups, the result ordering (newest first), and that errors carry a request_id to quote to support. That is far more than the structured data supplies.

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?

Three dense sentences, each earning its place, with the two modes front-loaded and cost/error behavior following. No filler, no restatement of the tool name, and the parenthetical error codes are compact 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?

For a 9-parameter read tool with zero annotations and no output schema, the description covers modes, ordering, filtering, cost, and error contract thoroughly. What remains thin is the shape of a returned user record and the auth/x402 path, though the latter is documented per-parameter in the schema.

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 100%, so the baseline is 3, but the description adds mode semantics the schema does not: that email/external_id select a single-record lookup rather than acting as filters, and that signup_host / signup_credit_type_id apply only to the list mode with newest-first ordering. It omits any mention of x402_payment or the api_key/project_id auth params, which the schema does cover.

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 and resource ('Look up one end user') and cleanly splits the tool into two modes: single-user lookup by email/external_id and a newest-first listing with filters. The purpose is unambiguous, but it never names a sibling (e.g. create_user, bulk_create_users) to sharpen the boundary, which keeps it just short of a 5.

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?

It states the concrete trigger for each mode: pass email or external_id to fetch one user, otherwise use signup_host / signup_credit_type_id to list. That is genuinely actionable routing guidance, but there are no exclusions or pointers to alternatives when the caller actually wants to create or mutate users.

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.

Resources