Skip to main content
Glama

Employment Hero Payroll MCP by usefulapi

List timesheets

keypay_list_timesheets
Read-only

List the business's timesheet lines: employee, start/end time, units, work type, location, status, comments, breaks. Filter by employee or date with OData, e.g. "EmployeeId eq 123 and StartTime gt datetime'2026-04-01T00:00:00'". GET /business/{businessId}/timesheet (OData: $filter, $orderby, $top, $skip).

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

A3.6/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 safe-read profile is covered. The description adds the concrete endpoint (GET /business/{businessId}/timesheet) and the OData query surface, but the pagination cap and defaults it mentions are duplicated in the schema, and it says nothing about result volume or error behavior. Modest added value over 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.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the purpose, then the filterable fields, then a concrete filter example, then the endpoint and query options. Dense but every clause carries information; the field enumeration is long but justified given there is no output schema.

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 compensates by listing the returned line fields, and it names the pagination mechanism ($top/$skip) that an agent needs to page through results. It is close to complete for a list tool; only the pagination token semantics and any default sort behavior are left to the schema.

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 the schema already documents top, skip, filter, orderby and business_id, including the 1-100 cap and the next_skip chaining hint. The description's added value is marginal — it reinforces that filtering is OData-based and supplies an EmployeeId conjunction example the schema doesn't show — but this is close to a baseline case where the schema does the heavy lifting.

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 the business's timesheet lines') and enumerates the fields returned (employee, start/end time, units, work type, location, status, comments, breaks), which is far more specific than the title. It does not explicitly name the sibling keypay_get_timesheet or explain how this list differs from fetching a single timesheet, so it stops short of full sibling differentiation.

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

Usage Guidelines4/5

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

Gives concrete usage context: filter by employee or date, with a worked OData example ('EmployeeId eq 123 and StartTime gt datetime''2026-04-01T00:00:00''') and the supported query options ($filter, $orderby, $top, $skip). No exclusions or named alternatives are offered, so it is clear context without routing guidance.

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.