Skip to main content
Glama

Invio Xero MCP

list_xero_pay_runs

list_xero_pay_runs
Read-only

This organisation's recent pay runs - period, payment date, status (DRAFT or POSTED) and organisation-wide totals. Read-only, for Australian, New Zealand and United Kingdom organisations (this refuses plainly for any other country). Also requires Xero's own Payroll setup to be complete for the organisation, and the Xero user who connected to have held payroll administrator access at the time - if either is missing this refuses plainly rather than returning an empty list, so report that rather than implying the organisation has no payroll data. Most recent first. netPay (amount actually paid to employees) is reported by every region; Australia additionally breaks out wages/deductions/tax/super, while New Zealand and the United Kingdom instead report totalCost (the full cost to the employer, including employer-side tax/super/NI that Australia reports separately) - do not assume a field is zero just because it is absent, it may simply not be something this region's own Xero API reports at that level. Use get_xero_pay_run_summary for per-employee detail and a comparison against the previous pay run of the same calendar. Returns up to 100 pay runs for the requested page. This tool cannot say whether a POSTED pay run has actually been paid out or reported to any tax authority - Xero has no API for either, in any region.

Input Schema

NameRequiredDescriptionDefault
pageNo1-based page number. Omit for page 1. Most recent pay runs come first.
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. Changed1 schema field changed
    • removedInput schema / additionalProperties
      Removed value: -false
  2. 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 and openWorldHint annotations, the description discloses regional eligibility, payroll setup and admin-access prerequisites, plain refusal behavior, pagination size, field availability differences by region, and an important limitation about POSTED pay runs. It even warns not to interpret absent regional fields as zero.

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 front-loaded and every sentence carries operational value: scope, regional constraints, refusal semantics, field differences, alternative tool, pagination, and a critical limitation. There is no filler or repeated schema text beyond what is necessary for safe interpretation.

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 supplies the return shape, regional field differences, pagination behavior, refusal semantics, and the important inability to determine whether a POSTED pay run has actually been paid or reported. An agent has enough context to call and interpret this tool 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?

The schema already documents both parameters at 100% coverage, including page numbering and the organisation display name. The description adds only limited parameter-specific meaning, notably the 100-pay-run page size and most-recent-first ordering, so it does not need to carry the parameter explanation burden.

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 states a specific verb and resource (list recent pay runs) and immediately names the key returned fields: period, payment date, status, and organisation-wide totals. It also distinguishes itself from the sibling get_xero_pay_run_summary by scoping that sibling to per-employee detail and prior-period comparison.

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?

It explicitly names the alternative tool and the condition that selects it: use get_xero_pay_run_summary for per-employee detail and comparison against the previous pay run. It also gives clear usage constraints by region and explains how to interpret refusal cases rather than treating them as empty payroll data.

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