Skip to main content
Glama

Invio Xero MCP

list_xero_payroll_employees

list_xero_payroll_employees
Read-only

This organisation's payroll employees - name, employment status, and (Australia only) whether Xero has a super fund on file for them and their ordinary earnings rate id. Read-only, for Australian, New Zealand and United Kingdom organisations (this refuses plainly for any other country - Xero's Payroll API covers no other region). 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. Active employees only unless includeInactive is set. Employment status comes straight from Xero for Australia; for New Zealand and the United Kingdom, Xero sends no status field at all, so it is derived here from whether Xero has recorded an end date - still accurate, just not Xero's own word for it. Super/pension fund membership is ONLY available for Australia from this tool - for New Zealand and the United Kingdom that fact is simply not returned (never a guessed "no fund"), say so rather than assuming everyone lacks one. NEVER returns a tax file number, a bank account or a home address - this tool does not read them from Xero at all. Does NOT know, and cannot answer, whether an employee has been paid, or whether anything has been reported to the ATO (Australia), IRD (New Zealand) or HMRC (United Kingdom) - Xero has no API for lodgement or payment status in any of the three. Returns up to 100 employees for the requested page; treat a full page of 100 as possibly incomplete and ask for the next page rather than assuming it is everyone.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo1-based page number. Omit for page 1.
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.
includeInactiveNoInclude terminated employees too. Omit or false for active employees only (Xero's own EmployeeStatus: ACTIVE or TERMINATED).

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 only declare readOnlyHint and openWorldHint, so the description carries the behavioral burden. It goes far beyond that by disclosing region-based refusal, setup/admin prerequisites, derived employment status for NZ/UK, Australia-only super fund data, explicit non-return of TFN/bank/address, and pagination behavior.

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 distinct operational guidance. It is front-loaded with the core purpose and then systematically covers constraints, regional differences, exclusions, and pagination without redundancy.

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 must explain return semantics, and it does thoroughly: what fields are returned, what is derived, what is never returned, what cannot be known, and how pagination works. An agent has enough information to call the tool correctly and interpret results.

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 baseline is 3. The description adds meaningful context for page (full page may be incomplete, request next page) and includeInactive (active-only default), which goes beyond the schema's basic field descriptions.

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 precise statement of what the tool returns: payroll employees with name, employment status, and Australia-only super fund and earnings rate ID. This clearly distinguishes it from sibling list tools like list_xero_payroll_earnings_rates and list_xero_pay_runs.

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 explicit when-to-use context: read-only, for AU/NZ/UK organisations only, with requirements around Payroll setup and admin access. It also states what the tool cannot answer (payment status, ATO/IRD/HMRC lodgement), but it does not name alternative sibling tools for those cases.

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