Skip to main content
Glama

Employment Hero Payroll MCP by usefulapi

Get pay run totals per employee

keypay_get_pay_run_totals
Read-only

Per-employee totals of a pay run (gross, net, tax withheld, super and the like; the fields depend on the region). Bank payment details are removed. GET /business/{businessId}/payrun/{payRunId}/totals.

Input Schema

NameRequiredDescriptionDefault
pay_run_idYesPay run id.
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 still adds genuine behavioral context beyond that: bank payment details are redacted from the response, and the returned field set varies by region, both of which affect how an agent should interpret results.

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?

One tight sentence plus the HTTP route; the payload description is front-loaded and nothing is padded. The trailing endpoint path is mildly redundant with the tool name but is compact and unambiguous.

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 carries the return-value burden and does so reasonably: it names the main totals categories, warns the field set is region-dependent, and notes bank details are stripped. It omits pagination/response-shape details, but for a two-parameter read that is a minor gap.

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% and both required parameters (business_id, pay_run_id) are documented in the schema, including the pointer to keypay_list_businesses. The description adds no parameter syntax or format detail, 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?

States a specific verb and resource ('Per-employee totals of a pay run') and enumerates the fields returned (gross, net, tax withheld, super), which is much more informative than the bare title. It does not, however, differentiate itself from the close sibling keypay_get_pay_run_summary, leaving the agent to infer the boundary.

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 when-to-use guidance at all: no condition, no prerequisites, and no mention of the neighboring tools (pay_run_summary, pay_run_payslips) an agent would have to choose between. The scope is implied by the name and path only.

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.