Skip to main content
Glama

Employment Hero Payroll MCP by usefulapi

Gross to net report

keypay_report_gross_to_net
Read-only

Gross-to-net report per employee: earnings by pay category, tax, deductions, super, net pay. Choose a date range (from_date + to_date) or one finalised pay run (pay_run_id). The report has no paging: at most 200 rows are returned (narrow with employee_id or location_id). GET /business/{businessId}/report/grosstonet.

Input Schema

NameRequiredDescriptionDefault
to_dateNoEnd of the date range (yyyy-mm-dd).
from_dateNoStart of the date range (yyyy-mm-dd), with to_date.
pay_run_idNoA pay run id: report that pay run (then from_date/to_date are ignored).
business_idYesBusiness id (from keypay_list_businesses).
employee_idNoOnly this employee.
location_idNoOnly this location.
pay_schedule_idNoOnly this pay schedule.

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, openWorldHint=true, destructiveHint=false, so safety is covered. The description adds meaningful non-structured behavior: there is no paging, at most 200 rows are returned, and results must be narrowed to stay within that cap. It doesn't cover auth/permission requirements, but that is a minor gap.

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?

Two dense sentences plus the endpoint path; every clause carries actionable information (report contents, mode selection, row cap, narrowing, endpoint). Front-loaded with purpose and scope, zero filler.

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?

With no output schema, the description usefully enumerates what the report returns (earnings by pay category, tax, deductions, super, net pay) and discloses the 200-row, no-paging behavior. An agent has everything needed to call it correctly.

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 description coverage is 100%, so the baseline is 3. The description adds selection semantics beyond the schema: pay_run_id is presented as an alternative mode rather than a filter, and narrowing via employee_id/location_id is tied to the 200-row cap, which the schema does not convey.

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 and resource (gross-to-net report per employee) and enumerates the report contents (earnings by pay category, tax, deductions, super, net pay). It is clearly distinguishable from siblings like keypay_report_leave_balances or keypay_get_pay_run_summary.

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 says to choose either a date range (from_date + to_date) or a single finalised pay run (pay_run_id), and tells the agent how to narrow results (employee_id or location_id). The alternative selection conditions are fully spelled out, not implied.

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.