Skip to main content
Glama

Invio Xero MCP

list_xero_payments

list_xero_payments
Read-only

List payments already recorded in Xero for the current organisation, optionally filtered by status (AUTHORISED or DELETED), by which invoice they were applied to, and by date range (fromDate/toDate, both inclusive). Read-only; nothing is created or changed - to RECORD a new payment, use create_xero_payment instead. amount is in the linked invoice's own currency, never assume it matches this user's Invio business currency. invoiceId/invoiceNumber are present only when this payment was applied to an invoice specifically - Xero also lets a payment be applied to a credit note, a prepayment or an overpayment, and this tool relays whichever is true rather than guessing. Returns up to 100 payments for the requested page; if pageCount shows more pages than were returned, say so rather than implying this is the full list. The result always echoes back exactly which filters were applied (appliedFilters) - relay that, not just your own memory of what you asked for.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo1-based page number - Xero returns up to 100 payments per page. Omit for page 1.
statusNoFilter to one Xero payment status: AUTHORISED (the normal, recorded state) or DELETED (reversed). Omit for both.
toDateNoOnly include payments dated ON OR BEFORE this date, YYYY-MM-DD (inclusive).
fromDateNoOnly include payments dated ON OR AFTER this date, YYYY-MM-DD (inclusive).
invoiceIdNoFilter to payments applied to one specific invoice. Omit for every invoice.
organisationNoThe Xero organisation to use, by its display name. Only needed if this connection reaches more than one organisation - omit it when there is only one.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnlyHint and openWorldHint; the description builds on that by revealing important non-obvious behaviors: amounts are in the linked invoice's currency, invoiceId/invoiceNumber appear only when applied to an invoice (not credit notes/prepayments/overpayments), and results echo applied filters. This goes beyond the 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?

The description is long but every sentence earns its place: purpose, alternative, currency caveat, invoiceId behavior, pagination handling, and filter echo. It is logically ordered and front-loaded with the core action before the caveats.

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 shoulders the burden of explaining return behavior, and it covers the essentials: pagination limit, pageCount guidance, currency semantics, and when invoiceId/invoiceNumber are present. An agent has everything needed to call this tool and interpret its results correctly.

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 every parameter thoroughly. The description adds a useful high-level summary of the filter options and inclusive date semantics, but most parameter detail remains in the schema; this is adequate without pushing above baseline.

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 payments already recorded in Xero'), then scopes it precisely: current organisation, optional filters for status, invoice, and date range. It also distinguishes itself from create_xero_payment, so an agent can tell them apart without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

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

Explicitly says this is read-only and nothing is created or changed, and names the sibling to use instead (create_xero_payment). It also gives operational guidance such as relaying pagination state and echoing appliedFilters rather than assuming completeness.

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