Skip to main content
Glama

PaySpace MCP by usefulapi

List an employee's recurring components or loans

payspace_list_recurring_components
Read-onlyIdempotent

List the recurring payroll components (EmployeeComponent) or loans (EmployeeLoan) of ONE employee for a payroll frequency and run. Personal data (pay). Get frequency from payspace_list_payroll_frequencies and period from payspace_list_payroll_runs. GET /odata/v2.0/{company}/{entity}?frequency=&period=&$filter=EmployeeNumber eq '...'.

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.
entityYesEmployeeComponent (recurring components) or EmployeeLoan (loans).
periodYesPayroll run (period), required by PaySpace. A value from payspace_list_payroll_runs (the CompanyRun lookup) for the chosen frequency.
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.
employee_numberYesEmployee number (the EmployeeNumber field of payspace_list_employees). PaySpace requires this filter for recurring components.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive, open-world behavior, so the description's job is to add context — and it does, flagging that the payload is personal pay data and exposing the underlying OData GET shape and employee-filter requirement. It says nothing about result size or how the entity choice changes the returned shape, which keeps it below a 5.

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?

Four short, front-loaded clauses: what it lists, the scope constraint, the personal-data warning, the prerequisite lookups, then the raw endpoint. No filler, and the most decision-relevant information comes first.

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?

For a 9-parameter, 4-required read tool with no output schema, the description covers entity semantics, the mandatory employee filter, and how to obtain frequency/period. It leaves the returned field set uncharacterized, which is tolerable given no output schema but still a gap.

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 all nine parameters are already documented; the description only restates the entity choice and the employee_number filter requirement. It adds no syntax, format, or interaction detail (e.g., how top/skip/count behave with the filter) beyond the schema.

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 concrete verb (List) and two concrete resources (EmployeeComponent / EmployeeLoan) scoped to exactly ONE employee for a given frequency and run. The capitalized 'ONE employee' plus the frequency/run qualifiers let an agent separate it from company-wide siblings like payspace_list_payroll_components without opening a schema.

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 explicit prerequisite ordering: fetch frequency from payspace_list_payroll_frequencies and period from payspace_list_payroll_runs before calling. It does not state when to prefer this over payspace_list_payroll_components or payspace_list_payslip_lines, so the alternative-selection guidance is inferential rather than explicit.

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.