Skip to main content
Glama

PaySpace MCP by usefulapi

List payroll components

payspace_list_payroll_components
Read-onlyIdempotent

List the company's payroll components (earnings, deductions, contributions) with their codes, for one payroll frequency and run. Get frequency from payspace_list_payroll_frequencies and period from payspace_list_payroll_runs. GET /odata/v2.0/{company}/ComponentCompany?frequency=&period=.

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

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 readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered. The description adds the concrete endpoint and the fact that both frequency and period are mandatory scoping inputs, but says nothing about return shape, result volume, or failure modes.

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 sentences plus an endpoint reference, with the scope constraint front-loaded ahead of the prerequisite guidance. The trailing raw OData path is somewhat redundant but adds little cost.

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 read-only paged list with full schema coverage and annotations, the description supplies scope, prerequisites and the underlying resource. Nothing essential for correct invocation is missing, though paging behavior is left entirely to the schema.

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 coverage is 100% and every parameter including top/skip/count/filter/orderby/company_id is already documented in the schema. The description only restates the sourcing of frequency and period, which the schema also says; 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?

States a specific verb+resource (list payroll components: earnings, deductions, contributions) scoped to one payroll frequency and run, and even names the backing endpoint. An agent can distinguish it from payspace_list_recurring_components and payspace_list_payslip_lines without opening the 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?

Explicitly states where the two required values come from ('get frequency from payspace_list_payroll_frequencies and period from payspace_list_payroll_runs'), which is actionable routing to prerequisites. It does not, however, contrast with alternatives or state when not to use it.

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.