Skip to main content
Glama
ZuckPay

zuckpay-mcp

Official
by ZuckPay

Consultar status de transação

getTransactionStatus
Read-only

Get the status of a ZuckPay transaction via transaction ID or external client ID. Statuses: PENDING, PAID, FAILED, EXPIRED.

Instructions

Consulta o status de uma transação ZuckPay (PIX, SPEI ou cartão) pelo transactionId OU pelo external_id_client do seu sistema (exatamente um dos dois). Status possíveis: PENDING, PAID, FAILED, EXPIRADO.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
transactionIdNoID da transação retornado pela ZuckPay na criação da cobrança
externalIdClientNoID externo do SEU sistema informado na criação (external_id_client)
Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so the tool is clearly non-destructive. Description adds value by listing possible statuses and the ID constraint, complementing annotations.

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?

Two concise sentences; first covers purpose and constraints, second enumerates statuses. No unnecessary words.

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?

No output schema, but description lists possible statuses, giving the agent an expectation. For a simple status check, this is adequate. Could mention other potential return fields, but not critical.

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 covers 100% of parameters with descriptions. The description adds the crucial constraint that exactly one parameter must be provided, which is not in the schema constraints.

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?

Description clearly states the verb ('Consulta'), resource ('status de transação'), and identifiers (transactionId or externalIdClient). It distinguishes from siblings like listTransactions by being a specific lookup tool.

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?

Explicitly states the constraint that exactly one of the two IDs must be provided. However, no explicit mention of when not to use or alternative tools for listing all transactions.

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/ZuckPay/zuckpay-mcp'

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