Skip to main content
Glama

List Refunds

list_refunds
Read-onlyIdempotent

List the authenticated customer's COMPLETED refunds (money actually returned), ordered most recent first and paginated. A refund is money returned to the customer for a previous charge. Refunds are issued by DIDWW staff or payment-provider flows against a payment (money goes back to the original payment method), or against an order or invoice (the amount is credited back to the account balance — credited_to_balance is true). Only completed refunds are listed — a refund still being processed does not appear here yet (same as the panel); tell the user to check back later or contact support about a refund in progress. Refund history is strictly read-only: no MCP tool can create, change or cancel a refund — customers request one through support. Amounts are negative (money returned) and include VAT. Returns each refund id, refund_target (payment, order or invoice), destination — where the money was returned: "original payment method" (a payment refund goes back to the card/PayPal/etc. it was paid from) or "account balance" (an order or invoice refund is credited to the account balance), amount, currency, description, reference, refunded_entities (type, reference, amount and currency of each refunded payment/order/invoice item — cross-reference the reference with list_payments / list_orders), credited_to_balance, paid_at and created_at, plus pagination meta. All amounts are in USD. Optionally filter by creation time with created_after / created_before.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoPage number (default 1).
page_sizeNoResults per page (default 50, max 100).
created_afterNoOnly refunds created at or after this ISO 8601 date-time (UTC), e.g. "2026-01-01T00:00:00Z".
created_beforeNoOnly refunds created before this ISO 8601 date-time (UTC), exclusive.

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare read-only/idempotent/non-destructive, and the description adds substantial beyond-annotation context: refunds cannot be created, changed or canceled by any MCP tool, amounts are negative and VAT-inclusive in USD, ordering is most-recent-first with pagination, and the completed-only visibility rule. This is rich behavioral disclosure.

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

Conciseness4/5

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

The key scoping constraint (completed only, read-only) is front-loaded and most sentences carry distinct information. It is a single dense block with some redundancy — the refund concept is defined twice ('money actually returned' then 'money returned to the customer') — which keeps it just short of a 5.

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

Completeness5/5

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

With no output schema, the description compensates by enumerating the return fields (id, refund_target, destination, amount, currency, reference, refunded_entities, credited_to_balance, timestamps, pagination meta) and explaining destination/credited_to_balance semantics. Nothing an agent needs to call or interpret it is missing.

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 page, page_size, created_after and created_before with defaults and formats. The description only restates that creation-time filtering is optional, adding no syntax or semantics beyond the schema — baseline 3 applies.

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?

States a specific verb and resource (list the authenticated customer's COMPLETED refunds) and immediately scopes it to money actually returned. It defines what a refund is and the two issuance pathways, so an agent knows exactly what this tool returns versus a generic payment/order listing.

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?

Gives clear context: only completed refunds appear (same as the panel), in-progress refunds should be handled by telling the user to check back or contact support, and refunded_entities references can be cross-referenced with list_payments / list_orders. It stops short of explicitly naming a sibling list tool to use instead for other refund states.

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