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

TableJSON 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. 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, but the description goes well beyond them: it discloses regional refusal behavior, prerequisites that cause plain refusals, ordering, regional differences in reported fields, pagination limits, and the tool's inability to confirm actual payment or tax reporting. No contradiction with 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 carries essential operational information: purpose, region restrictions, prerequisites, field semantics, sibling routing, pagination, and limitations. It is front-loaded with the core purpose and then layers caveats in a logical order, with no filler.

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?

There is no output schema, so the description carries the full burden of explaining return values. It covers the fields returned, regional variants (netPay vs totalCost), pagination, refusal behavior, and important limitations. An agent has enough to call this tool correctly and interpret results.

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 both parameters are already documented in the schema. The description adds some useful context, such as 'Most recent first' for page and the single-organisation omission guidance, but it does not substantially extend the schema's parameter explanations. Baseline 3 is appropriate.

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: it lists the organisation's recent pay runs with period, payment date, status, and totals. It also distinguishes itself from get_xero_pay_run_summary by explicitly naming that sibling for per-employee 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 Guidelines5/5

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

The description gives explicit routing guidance: 'Use get_xero_pay_run_summary for per-employee detail and a comparison against the previous pay run.' It also specifies when the tool will refuse rather than return data, covering region, Payroll setup, and administrator access prerequisites, which helps an agent decide whether to call it.

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