Skip to main content
Glama

Employment Hero Payroll MCP by usefulapi

Leave balances report

keypay_report_leave_balances
Read-only

Leave balances of all employees as at a date, per leave category. The report has no paging: at most 200 rows are returned (narrow with location_id or leave_category_id). For one employee use keypay_get_leave_balances. GET /business/{businessId}/report/leavebalances.

Input Schema

NameRequiredDescriptionDefault
as_at_dateNoBalances as at this date (yyyy-mm-dd); default today.
business_idYesBusiness id (from keypay_list_businesses).
location_idNoOnly this location.
leave_category_idNoOnly this leave category.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/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 genuinely non-obvious behavior: the report has no paging and is capped at 200 rows, plus the mitigation. It stops short of describing row shape or truncation signaling, but this is real value beyond the annotations.

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?

Three short sentences, zero filler, and the most decision-relevant facts (scope, row cap, sibling alternative) are front-loaded. Every sentence earns its place.

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?

Given a simple 4-parameter read with no output schema, the description covers scope, cardinality limits, mitigation, sibling routing, and the underlying endpoint. Nothing an agent needs to invoke it correctly is missing.

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 baseline is 3, but the description adds purpose to the two optional filters beyond the schema's terse 'Only this location'/'Only this leave category' – they are the levers for staying under the 200-row cap. That extra semantics justifies a 4.

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?

States a specific verb+resource+scope: leave balances of all employees as at a date, per leave category. It also distinguishes itself from the single-employee sibling keypay_get_leave_balances, so an agent can route correctly without opening either schema.

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

Usage Guidelines5/5

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

Explicitly names the alternative ('For one employee use keypay_get_leave_balances') and gives the condition that selects it. It also tells the agent when to narrow with location_id or leave_category_id, i.e. when the 200-row cap would bite.

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.