Skip to main content
Glama

List pay periods

rotacloud_list_pay_periods
Read-only

List pay periods overlapping a date range (id, name, start/end date, locked). GET /pay_periods.

Input Schema

NameRequiredDescriptionDefault
endYesLast date (yyyy-mm-dd).
limitNoResults per page, 1-500 (RotaCloud may cap it lower; the reply's total and next_offset show what is left).
startYesFirst date (yyyy-mm-dd).
offsetNoIndex of the first result; pass the previous reply's next_offset.

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, so the safety profile is covered. The description usefully adds that results are overlap-filtered and enumerates returned fields (id, name, start/end, locked), but says nothing about ordering, pagination behavior, or empty-result handling beyond what the schema already implies.

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

Conciseness5/5

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

A single front-loaded sentence carries the scope and payload, with the endpoint appended tersely. No filler; every clause earns its place.

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 fields, and the schema already covers pagination parameters. It is nearly complete; only ordering and pagination semantics in the response are left implicit.

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 start, end, limit, and offset are already documented with formats and constraints. The description adds no parameter detail beyond the generic 'date range', 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 a specific verb (List) and resource (pay periods) and adds scope — 'overlapping a date range' — plus the returned fields. It is clear what the tool does, though it never names or distinguishes itself from the nearby rotacloud_get_payroll sibling.

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

Usage Guidelines3/5

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

The overlap-based date range implies when this list is appropriate, but there is no explicit when-to-use guidance and no routing away from rotacloud_get_payroll or the other list_* tools. Usage is only inferable.

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.