Skip to main content
Glama

Employment Hero Payroll MCP by usefulapi

List pay run summaries

keypay_list_pay_run_summaries
Read-only

Pay runs with their totals: total hours, gross wages and net wages, plus the usual pay run fields. GET /business/{businessId}/payrun/summary (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

B3.2/5.0
Behavior3/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 the safety profile is covered. The description adds the useful detail that this is a GET endpoint on the OData summary resource, implying OData query/pagination behavior and no side effects, but it says nothing about permissions (business/API key scope), rate limits, or result size behaviour.

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?

Two tight sentences: the returned payload is front-loaded and the REST/OData endpoint note follows. Nothing is wasted, though the endpoint path is only marginally useful to an agent that already has the schema and could have been replaced with sibling-routing guidance.

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

Completeness3/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 does carry return-value burden and it partially fulfils it by listing the totals returned; however, 'the usual pay run fields' is vague and the field names/serialisation are left implicit. For a five-parameter OData listing tool surrounded by near-synonymous siblings, more routing and result-shape detail would be needed for a higher score.

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 top, skip, filter, orderby and business_id are all documented with types and OData syntax examples and pagination hints directly in the schema. The description adds no parameter-level meaning at all, so the baseline of 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?

The description names the resource (pay runs) and the specific payload it returns (total hours, gross wages, net wages plus standard pay run fields), which is a clear verb+resource statement. It does not, however, distinguish itself from close siblings like keypay_list_pay_runs or keypay_get_pay_run_summary, leaving the agent to infer which 'pay run' variant to pick.

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?

There is no explicit guidance on when to use this tool versus keypay_list_pay_runs (list view) or keypay_get_pay_run_summary (single entity). The listing semantics are only implied by the word 'summaries'. No prerequisites, pagination workflow, or exclusions are stated beyond what the schema already shows.

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.