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

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. Changed4 schema fields changed
    • removedInput schema / additionalProperties
      Removed value: -false
    • removedInput schema / properties / toDate / $ref
      Removed value: -"#/properties/fromDate"
    • addedInput schema / properties / toDate / pattern
      Added value: +"^\\d{4}-\\d{2}-\\d{2}$"
    • addedInput schema / properties / toDate / type
      Added value: +"string"
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation it adds real context: nothing is created or changed, the 100-per-page cap with pageCount guidance, the warning to relay appliedFilters rather than memory, and the caveat that each credit note carries its own currency. It does not clarify auth/scope requirements or rate limits, so it stops short of a 5.

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?

Front-loaded with purpose and type definitions, and every sentence carries operational content (pagination, currency caveat, appliedFilters, sibling pointer). It is a single dense paragraph that slightly restates the type meanings already in the schema enum descriptions, keeping it from 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?

No output schema exists, yet the description explains the key return semantics (remainingCredit, appliedFilters, pageCount) so an agent can interpret results correctly. For an 8-param, filter-only read tool this covers everything needed to call and interpret it.

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 coverage is 100%, so the schema already documents all 8 params; the description nonetheless adds value by reinforcing inclusive fromDate/toDate semantics, the exact-vs-partial reference distinction, and the mutual exclusion rule. It adds marginal but genuine meaning on top of the schema rather than repeating it wholesale.

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?

Specific verb+resource ('List credit notes from Xero for the current organisation') with an immediate disambiguation of the two types (ACCRECCREDIT vs ACCPAYCREDIT) including their business meaning. It also names the sibling it is not (get_xero_credit_note), so an agent can route without opening either 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?

Explicit exclusivity rule: 'use exactly one, never both' for reference vs referenceContains, with the condition that selects each ('when you know the reference verbatim' vs 'only know part'). It also routes to get_xero_credit_note for line-item detail and states that omitted filters mean 'both types' / 'every status'.

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