Skip to main content
Glama

Employment Hero Payroll MCP by usefulapi

List pay runs

keypay_list_pay_runs
Read-only

List the business's pay runs: id, pay schedule, pay period start/end, date paid, finalised flag, payslips published, notation. Newest first with orderby "PayPeriodEnding desc". GET /business/{businessId}/payrun (OData).

Input Schema

NameRequiredDescriptionDefault
topNoResults per request, 1-100 (default 25; the API caps it at 100).
skipNoResults to skip (default 0). Pass the previous reply's next_skip.
filterNoOData v3 $filter. Property names are capitalised, e.g. "Surname eq 'Smith'", "StartTime gt datetime'2026-04-01T00:00:00'", "DefaultSuperRate ne 9.5M".
orderbyNoOData $orderby, e.g. "Name" or "PayPeriodEnding desc".
business_idYesBusiness id (from keypay_list_businesses).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so safety is covered. The description adds real behavioral context beyond that: the default sort order, that results are the business's pay runs, and that the endpoint is OData-based (implying $filter/$orderby/$top/$skip semantics).

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 purpose and the field list are front-loaded, and the endpoint/OData detail is a compact trailing clause. Dense but every element is relevant; the field enumeration is slightly list-heavy but earns its place given there is no output schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/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 usefully enumerates the returned fields and gives the default sort and endpoint. Combined with the fully documented input schema, an agent has enough to invoke and paginate correctly, though sibling disambiguation is still absent.

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 all five parameters are already documented in the schema. The description reinforces OData semantics and the default ordering but adds no syntax or constraint detail beyond what the schema provides; baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource (list the business's pay runs) and enumerates the returned fields, so the agent knows exactly what comes back. It does not explicitly distinguish itself from near-siblings like keypay_list_pay_run_summaries or keypay_get_pay_run, which is the only gap.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

The description states a default ordering ('Newest first with orderby "PayPeriodEnding desc"') but never says when to use this tool versus keypay_list_pay_run_summaries, keypay_get_pay_run, or keypay_list_pay_schedules. Usage is only implied by the tool name and resource.

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.