Skip to main content
Glama

Employment Hero Payroll MCP by usefulapi

List locations

keypay_list_locations
Read-only

Locations of the business (sites, departments): id, name, parent, fully qualified name, state. GET /business/{businessId}/location (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

A3.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds value beyond that by disclosing the concrete result fields (id, name, parent, fully qualified name, state) and the OData endpoint shape, which matters since no output schema exists.

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 compact sentence plus the endpoint reference; the resource and its returned fields are front-loaded with no filler. The telegraphic phrasing ('Locations of the business') is terse but readable and nothing is wasted.

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?

For a read-only list tool with a fully documented schema and no output schema, the description covers the resource and return fields adequately; pagination semantics are carried by the schema's skip/top descriptions. Only the parent/hierarchy semantics of the location tree are left unexplained.

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 fully documents top, skip, filter, orderby and business_id with defaults and examples. The description only alludes to OData generally and adds no parameter-level meaning beyond the schema, so the baseline 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 the specific resource (business locations/sites/departments) and enumerates the fields returned, plus the underlying endpoint. It clearly distinguishes itself from siblings like keypay_list_businesses or keypay_list_employees by naming the distinct resource, though it never explicitly contrasts with an alternative.

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 when-to-use guidance, no prerequisites beyond the schema's note that business_id comes from keypay_list_businesses, and no mention of when a different sibling (e.g. keypay_get_business) would be preferred. Usage must be inferred from the tool name and field list.

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.