Skip to main content
Glama

Employment Hero Payroll MCP by usefulapi

List pay run warnings

keypay_list_pay_run_warnings
Read-only

Warnings on a pay run (for example an employee paid below their award rate or with a negative net pay): type, employee and message. GET /business/{businessId}/payrun/{payRunId}/warnings.

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

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 useful content beyond that by describing the shape and examples of warnings, but says nothing about pagination, volume of warnings, or auth scoping.

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?

A single tight sentence plus the REST path; the subject ('Warnings on a pay run') is front-loaded with the examples and field list following. Nothing is padded, though the trailing endpoint adds little for an agent that already has the tool name.

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?

No output schema exists, so the description carries the burden of describing the return contents and does so via the type/employee/message enumeration. For a two-parameter read-only tool with full annotation coverage, that is nearly complete; only pagination and warning-count expectations are 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%: both business_id and pay_run_id are documented in the schema, including the pointer to keypay_list_businesses. The description adds no parameter meaning beyond that, 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+resource ('Warnings on a pay run') and enumerates the returned fields (type, employee, message) with concrete examples such as below-award pay or negative net pay. It is clearly distinguishable from siblings like keypay_get_pay_run_summary or keypay_get_pay_run_totals, though it never names an alternative explicitly.

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 statement of when to reach for this tool versus the other pay-run tools (summary, totals, payslips), nor any prerequisites beyond the required ids. Usage is only implied by the resource name.

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.