Skip to main content
Glama

PaySpace MCP by usefulapi

List payroll frequencies

payspace_list_payroll_frequencies
Read-onlyIdempotent

List the payroll frequencies of a company (the CompanyFrequency lookup). A value goes into the frequency argument of payspace_list_payroll_components, payspace_list_payroll_runs and payspace_list_recurring_components. GET /odata/v2.0/{company}/Lookup/CompanyFrequency.

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`.
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

A3.9/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive and open-world, so the safety profile is covered. The description adds that this is a lookup endpoint (small, stable result set) and gives the raw path, but says nothing about result size, caching value, or paging behavior beyond the endpoint hint.

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?

Three short sentences: purpose first, downstream use second, technical endpoint last. Everything is load-bearing, though the raw GET path is of limited value to an agent that already has the tool bound.

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?

No output schema exists, but for a small lookup list the description conveys enough: what it returns (company payroll frequencies) and how the values are consumed. The only gap is that it doesn't describe the shape of returned items (code vs. name/id), which would matter for constructing the downstream `frequency` argument.

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%, with $top/$skip/$filter/$orderby and company_id already documented in detail. The description adds no parameter-level guidance (e.g. whether filtering is useful on a small lookup), so baseline 3 applies.

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?

Specific verb plus resource ('List the payroll frequencies of a company') with the underlying entity named (CompanyFrequency lookup) and the exact endpoint. It is clearly distinguishable from generic list siblings because it identifies itself as a lookup feeding a foreign-key argument.

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 states the downstream use: values go into the `frequency` argument of payspace_list_payroll_components, payspace_list_payroll_runs and payspace_list_recurring_components. It doesn't explicitly say 'call this first if you don't already have a frequency id', but the implication is strong and the alternatives are named.

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.