Skip to main content
Glama

Employment Hero Payroll MCP by usefulapi

List pay schedules

keypay_list_pay_schedules
Read-only

Pay schedules of the business: id, name, frequency, last date paid, last pay run. Bank and tax account details are removed. GET /business/{businessId}/payschedule (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 contributes one genuinely useful behavioral fact — 'Bank and tax account details are removed' — i.e. field-level redaction of sensitive data, which the annotations do not convey; it adds nothing on pagination limits or rate limits beyond what the schema's top/skip text already says.

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 compact fragments with no filler: the resource and returned fields come first, then the endpoint/OData note. Front-loaded and scannable, though the raw GET path adds little beyond what the schema already implies.

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?

There is no output schema, and the description correctly compensates by listing the returned fields plus the fact that bank/tax details are stripped. Combined with annotations covering read-only safety and the schema covering pagination, an agent has enough to call it correctly; only cross-sibling routing guidance is 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%, so top, skip, filter, orderby and business_id are all fully documented in the schema, including the next_skip pagination convention and OData v3 filter examples. The description only adds '(OData)' and the path template, which is baseline-level value; no additional parameter meaning is provided.

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 (list pay schedules of the business) and enumerates the returned fields (id, name, frequency, last date paid, last pay run), which clearly separates it from siblings like keypay_list_pay_runs or keypay_list_pay_categories. It does not explicitly name those siblings, so a 5 is not warranted.

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?

No guidance on when to choose this over keypay_list_pay_runs (the closest sibling) or on prerequisites beyond the business_id source. The endpoint string and '(OData)' hint imply a filtered list call but do not state usage conditions or exclusions.

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.