Skip to main content
Glama

Field Service Business Platform by Doing Work

payroll_getPeriod

The shop's pay period setting (weekly, biweekly, semimonthly or monthly) and the current period's dates. Weekly from Monday until the owner or office set it.

Input Schema

NameRequiredDescriptionDefault
shop_idYes

Output Schema

NameRequiredDescriptionDefault
settingYes
period_endYes
period_startYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3/5.0
Behavior3/5

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

No annotations are provided, so the description carries the burden. It does add genuinely useful behavioral context: the default is weekly starting Monday 'until the owner or office set it.' However, it says nothing about permissions, failure modes, or how the setting interacts with payroll runs.

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 sentences with no filler, and the core behavior is front-loaded. The trailing clause about the Monday default is slightly awkward but still earns its place.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists so return values needn't be explained, and this is a one-parameter read tool, so the description is nearly sufficient. It still leaves the shop_id parameter and any relevant edge cases (e.g., unset period, shop not found) undocumented.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% for the single required shop_id parameter, and the description does not explain that shop_id identifies which shop's period to fetch. 'The shop's' hints at scoping, but the parameter itself is left entirely to the schema's type declaration.

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: retrieves the shop's pay period setting and current period dates, enumerating possible values (weekly, biweekly, semimonthly, monthly). It is clearly distinguishable from payroll_setPeriod and payroll_hours, though it does not explicitly name those siblings.

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 explicit when-to-use or when-not-to-use guidance and no mention of the natural counterpart payroll_setPeriod. Usage is only implied by the getter framing ('The shop's pay period setting').

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