Skip to main content
Glama

Invio Xero MCP

list_xero_credit_notes

list_xero_credit_notes
Read-only

List credit notes from Xero for the current organisation - ACCRECCREDIT (against a sales invoice, reduces what a customer owes) or ACCPAYCREDIT (against a bill, reduces what this business owes a supplier), optionally filtered by status, by issue date range (fromDate/toDate, both inclusive), and by reference (exact match with reference, or a partial case-insensitive match with referenceContains - use exactly one, never both). Read-only; nothing is created or changed. Each credit note carries its OWN currency straight from Xero - never assume it matches this user's Invio business currency. Returns up to 100 credit notes for the requested page; if pageCount shows more pages than were returned, say so rather than implying this is the full list. remainingCredit is how much of each credit note has NOT yet been applied against an invoice or refunded. The result always echoes back exactly which filters were applied (appliedFilters) - relay that, not just your own memory of what you asked for. Use get_xero_credit_note for full line-item detail on one credit note.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo1-based page number - Xero returns up to 100 credit notes per page. Omit for page 1.
typeNoACCRECCREDIT = credit notes against sales invoices. ACCPAYCREDIT = credit notes against bills. Omit for both.
statusNoFilter to one Xero credit note status (e.g. AUTHORISED, PAID). Omit for every status.
toDateNoOnly include records dated ON OR BEFORE this issue date, YYYY-MM-DD (inclusive - this IS the last date included, not the day after).
fromDateNoOnly include records dated ON OR AFTER this issue date, YYYY-MM-DD (inclusive). Filters on the issue Date, never the due date.
referenceNoExact match on the Reference field. Use this when you know the reference verbatim - cannot be combined with referenceContains.
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.
referenceContainsNoCase-insensitive PARTIAL match on the Reference field (e.g. "1234" matches a reference containing "PO-1234"). Use this when you only know part of the reference. Cannot be combined with reference - if you know the exact text, use reference instead.

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?

Beyond the readOnlyHint annotation, the description adds substantial behavioral detail: pagination limits and pageCount honesty, per-credit-note currency independence, remainingCredit semantics, and the appliedFilters echo requirement. These are exactly the non-obvious behaviors an agent needs to avoid incorrect assumptions.

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 description is long but each sentence carries operational value, and the most important scoping and behavioral warnings are front-loaded. The only minor redundancy is restating read-only behavior already present in annotations, but this does not significantly bloat the text.

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 explaining key response concepts: page size, pageCount, remainingCredit, appliedFilters, and currency. It also covers filter semantics and points to the sibling tool for deeper detail. An agent has enough context to call this correctly and interpret the result responsibly.

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

Parameters5/5

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

Although schema coverage is 100%, the description adds meaning beyond the schema: it explains inclusive date boundaries, the exact-match vs partial-match distinction between reference and referenceContains, the 'use exactly one, never both' rule, and the practical meaning of ACCRECCREDIT vs ACCPAYCREDIT. This materially improves correct parameter usage.

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?

The description opens with a specific verb and resource ('List credit notes from Xero') and immediately clarifies the two credit-note types. It also distinguishes itself from get_xero_credit_note by pointing to that tool for full line-item detail, so an agent can tell them apart.

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?

The description gives clear context: optional filters, read-only behavior, and an explicit pointer to get_xero_credit_note when full line-item detail is needed. It does not explicitly enumerate when not to use this tool versus create_xero_credit_note, but the read-only statement and sibling context make the boundary clear enough.

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