Skip to main content
Glama

PaySpace MCP by usefulapi

List payroll runs

payspace_list_payroll_runs
Read-onlyIdempotent

List the payroll runs (periods) of a company for one frequency (the CompanyRun lookup). A value goes into the period argument of payspace_list_payroll_components and payspace_list_recurring_components. GET /odata/v2.0/{company}/Lookup/CompanyRun?frequency=.

Input Schema

NameRequiredDescriptionDefault
topNoPage size ($top, default and maximum 100).
skipNoRecords to skip ($skip), for paging: page 2 of size 100 is skip=100.
countNoInclude the total number of matching records as @odata.count.
filterNoOData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.
orderbyNoOData $orderby, for example `LastName asc`.
frequencyYesPayroll frequency, required by PaySpace. A value from payspace_list_payroll_frequencies (the CompanyFrequency lookup).
company_idNoPaySpace company id or company code. Optional when the credentials give access to exactly one company; call payspace_list_companies to see them.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, so the safety profile is fully covered and the description doesn't need to repeat it. It adds modest behavioral context by exposing the GET /odata/v2.0/{company}/Lookup/CompanyRun endpoint and that frequency is a mandatory scoping dimension (one frequency per call). It says nothing about result size, default paging, or what the returned records look like.

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 the purpose front-loaded and the downstream-consumption note second. The raw endpoint string '(GET /odata/v2.0/{company}/Lookup/CompanyRun?frequency=)' is developer-facing filler for an agent and ends in a dangling '?frequency=', which is minor waste but not harmful.

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 100% schema coverage, no output schema, and annotations covering safety, the description supplies what's needed: what is listed, the scoping dimension, and how the results are consumed. It could say more about the shape of the returned period objects (e.g., id vs. label) and that results are capped at 100 per page, but nothing required to invoke it correctly is missing.

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?

Schema coverage is 100%, so all seven parameters are already documented, setting a baseline of 3. The description adds genuine semantics the schema lacks: the frequency parameter maps to a specific lookup entity (CompanyFrequency/CompanyRun) and the returned values are valid `period` arguments for two named sibling tools, explaining why frequency is required.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('List the payroll runs (periods) of a company for one frequency') and identifies the underlying entity ('the CompanyRun lookup'), which separates it from sibling lookups like payspace_list_payroll_frequencies. An agent knows exactly what comes back: run/period identifiers for a given frequency.

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?

Explicitly tells the agent where the output goes: 'A value goes into the period argument of payspace_list_payroll_components and payspace_list_recurring_components', which makes the call ordering obvious. It does not state when not to use it or that the frequency argument should first come from payspace_list_payroll_frequencies (that routing only appears in the schema), so it stops short of a full 5.

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.