Skip to main content
Glama

Get payroll setup

get_payroll_setup
Read-only

Read what this business's payroll accepts: pay frequencies, package kinds, statutory lines and whether each applies, line roles by category, reserved codes, formula names, the registrations held or missing, the payroll-liability accounts, how many templates, schedules and leave types exist, and the returns a pay run files (evaluate_report source ids). Read it before a payroll write. It reads only; nothing is changed.

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, and the closing sentence 'It reads only; nothing is changed' largely restates that rather than adding new behavioral information. The genuinely additive part is the precondition framing ('read before a payroll write'), which tells the agent where this sits in a workflow. Nothing is said about response size, pagination, or cost, which matters given the breadth of data promised.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

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

The opening sentence is a ~55-word comma-spliced list of nine-plus categories, which is hard to scan and buries the payoff categories ('registrations held or missing', 'returns a pay run files') in the middle of the run. The two short trailing sentences are tight and well-placed, and the list does carry real information, but a bulleted or shorter front-load would have been more usable.

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, so the description carries the entire burden of telling the agent what comes back, and it does so in detail across all the setup domains an agent would need before a payroll write. It is complete in coverage; it is only slightly weak in not indicating shape or scale of the response.

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?

The tool takes zero parameters, so there is no parameter semantics to document and the baseline of 4 applies. The description correctly avoids inventing filter/scope arguments and instead frames the tool as implicitly scoped to 'this business'.

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?

Opens with a specific verb+resource ('Read what this business's payroll accepts') and enumerates the concrete categories returned: pay frequencies, package kinds, statutory lines, line roles, reserved codes, formula names, registrations, liability accounts, and report source ids. The mention of 'how many templates, schedules and leave types exist' implicitly separates it from the list_payslip_templates / list_leave_types / list_payrun_schedules siblings. It stops short of the 5 because the enumeration is dense enough that the core identity ('a setup/config snapshot') takes a moment to extract.

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 one clear, actionable timing rule: 'Read it before a payroll write,' which is exactly the precondition an agent needs for save_payrun/populate_payrun flows. It does not name alternatives or state when-not to use it (e.g., versus get_business_profile or get_source_codes for a narrower lookup), so it falls short of explicit alternative routing.

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.

Resources