Skip to main content
Glama

list_invoice_payments

Read-onlyIdempotent

List recorded payments and refunds for an invoice in the approved business. Amounts are minor units in each payment's currency.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "id": "<id>"
    },
    "name": "list_invoice_payments"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYes
offsetNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world, so the safety profile is covered. The description adds genuine value by stating that refunds are included and that amounts are minor units in each payment's currency, but says nothing about ordering, page size, or how the offset parameter behaves across pages.

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 short sentences, no waste, and the core purpose is front-loaded before the amount-format caveat. Every sentence earns its place.

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 a simple read-only list tool with no output schema, the essential contract is conveyed, but the missing pagination semantics (offset-only, no limit) and absent ordering information leave an agent unable to predict what a page contains or how to iterate.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and there are two parameters. The phrase 'for an invoice' only implicitly identifies 'id' as the invoice UUID, and the 'offset' parameter (0–100000, no companion limit) is never explained, so the description leaves half the input surface undocumented.

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 gives a specific verb plus resource ('List recorded payments and refunds for an invoice') and adds scope ('in the approved business'). It is clear what data comes back, though it does not name any sibling to distinguish itself from e.g. list_appointment_payments or get_appointment_payments.

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?

Usage is only implied: you need an invoice in the current business context. There is no statement of when to prefer this over the sibling payment-listing tools or over the mutation siblings like record_invoice_payment/remove_invoice_payment, and no exclusions or prerequisites (e.g. permissions) are given.

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