Skip to main content
Glama
macedoflp

Asaas MCP Server

by macedoflp

list_payments

List payments with official offset/limit pagination and filters by status, customer, due date, billing type, or external reference.

Instructions

Lista cobranças com paginação oficial (offset/limit) e filtros por status, cliente e vencimento

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoNúmero máximo de elementos retornados por página (máximo 100, padrão: 25)
offsetNoElemento inicial da consulta (deslocamento para paginação oficial Asaas, padrão: 0)
statusNoFiltrar por status da cobrança
customerNoFiltrar cobranças por ID do cliente
dueDate_geNoFiltrar cobranças com vencimento maior ou igual a YYYY-MM-DD
dueDate_leNoFiltrar cobranças com vencimento menor ou igual a YYYY-MM-DD
billingTypeNoFiltrar por forma de pagamento
externalReferenceNoFiltrar pelo seu identificador externo de cobrança

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.3/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It does disclose a meaningful behavioral trait – pagination via offset/limit ('paginação oficial') – and implies a read-only listing operation, but it omits auth requirements, default ordering, result size behavior, and any rate-limit context.

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?

A single front-loaded sentence that states the operation, the pagination mechanism, and the filter axes with zero filler. Nothing can be trimmed without losing information.

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

Completeness3/5

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

For an 8-parameter, unannotated, no-output-schema tool, the description is thin: it never touches return shape, ordering, or result completeness. The rich input schema compensates for the parameter side, but the behavioral surface remains underdescribed.

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 schema already documents all 8 parameters thoroughly (limits, defaults, date formats, enums). The description adds only a coarse summary of filters and doesn't mention billingType or externalReference, so it earns the baseline 3 rather than more.

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?

States a specific verb and resource ('Lista cobranças') plus the operation's shape (pagination with offset/limit and filters). It does not distinguish itself from the sibling get_payment, which is also payment-retrieval, so it falls 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 Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description enumerates filter dimensions, which hints at when the tool is useful, but gives no explicit guidance on when to use list_payments versus get_payment or simulate_payment, and no prerequisites or exclusions. Only implied usage is present.

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