Skip to main content
Glama

PaySpace MCP by usefulapi

List payslips for a month

payspace_list_payslips
Read-onlyIdempotent

List employee payslips (totals per employee) for a calendar year and month. Personal data (pay). GET /odata/v2.0/{company}/EmployeePayslip/{year}/{month}.

Input Schema

NameRequiredDescriptionDefault
topNoPage size ($top, default and maximum 100).
skipNoRecords to skip ($skip), for paging: page 2 of size 100 is skip=100.
yearYesYear, for example 2026.
countNoInclude the total number of matching records as @odata.count.
monthYesMonth, 1 to 12.
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

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and openWorld. The description adds two useful facts beyond that: the payload contains personal pay data, and the underlying GET path identifies the entity. It says nothing about paging behavior in practice, response size limits, or what a per-employee total actually aggregates.

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 short sentences with the scope front-loaded; nothing is padded. The raw endpoint path is arguably redundant, though it does hint at the entity name for building $filter/$orderby expressions, so it earns partial keep.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With eight parameters, no output schema, and a paging-capable list endpoint, the description should say more about what comes back (fields per employee, whether totals include components/deductions) and how it relates to payslip_lines. It covers the entity and scope but leaves return shape and drill-down workflow to inference.

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 eight parameters including $top/$skip/$filter/$orderby and company_id fallback are already documented in the schema. The description's "calendar year and month" restates the required params without adding syntax, format, or edge-case guidance, so 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 and resource ("List employee payslips") plus the aggregation granularity ("totals per employee"), which implicitly distinguishes it from payslip_lines. It does not name any sibling tool explicitly, so the differentiation is inferred rather than stated.

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?

Usage is implied by "totals per employee" and the required year/month scope, which suggests when a detail-line tool like payspace_list_payslips_lines would be better. But there is no explicit when-to-use statement, no exclusions, and no mention of prerequisites (e.g. needing company_id only in multi-company credentials is left entirely to the schema).

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.