Skip to main content
Glama

pagarme_customers_list

Read-onlyIdempotent

Clientes e endereços no Pagar.me V5. Ações:

  • list: lista clientes (page, size; data: name, email, document, code).

  • get: cliente por customer_id.

  • list_addresses: endereços do cliente (requer customer_id).

  • get_address: endereço (requer customer_id + address_id).

[Flattened action: list]

Bulk support: accepts customer_ids, address_ids for batched execution.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo
pageNo
sizeNo
accountNo
address_idNo
address_idsNo
customer_idNo
customer_idsNo

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations provide readOnlyHint, idempotentHint, and destructiveHint, indicating a safe operation. The description adds useful behavioral context like bulk support via customer_ids and address_ids, and pagination with page/size. It does not contradict annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is somewhat verbose with multiple actions and a flattened action note, but it is structured with bullet points. It could be more concise by focusing solely on the list action.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (8 optional parameters, no output schema), the description lacks complete guidance. It does not describe the return format, the exact meaning of 'data' parameter, or how bulk execution works in detail. Annotations cover safety but not functional completeness.

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?

With 0% schema description coverage, the description must compensate. It explains parameters for the list action (page, size, data) and mentions customer_id, address_id, customer_ids, address_ids in context. However, the 'account' parameter is not explained, and the 'data' parameter's exact role is ambiguous (filter vs. output fields).

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 clearly indicates the tool is for listing customers, with the action 'list' highlighted via 'Flattened action: list'. It includes specific fields (name, email, document, code) and differentiates from sibling tools like pagarme_customers_get and pagarme_customers_list_addresses. However, the inclusion of multiple actions (get, list_addresses, get_address) adds slight ambiguity.

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 listing customers but does not explicitly state when to use this tool versus alternatives. It mentions the list action with parameters, but no explicit when-not or alternative tool guidance.

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.