Skip to main content
Glama

PaySpace MCP by usefulapi

List records of another entity

payspace_list_records
Read-onlyIdempotent

List records of another read-only entity set: CompanyEmploymentCategory, CompanyEmploymentSubCategory, CompanyLeaveReason, CompanyPositionFamily, CompanyPositionFunctionArea, CompanyTrainingCourse, CompanyQualification, CostingProjectActivity, OrganizationGrade, EmployeeAsset, EmployeeClaim, EmployeeDependant, EmployeeIncident, EmployeePayRate, EmployeeProject, EmployeeQualification, EmployeeSkill, EmployeeOutOfOffice. GET /odata/v2.0/{company}/{entity}. Employee-level entities contain personal data.

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.
entityYesEntity set name.
filterNoOData $filter, for example `EmployeeNumber eq 'E001'` or `contains(LastName,'Smith')`. Field names: see the vendor docs for the entity.
selectNoOData $select: comma-separated field names to return (smaller replies).
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.3/5.0
Behavior3/5

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

Annotations already cover read-only, idempotent, non-destructive and open-world behavior, so the bar is lower. The description contributes one genuinely additive behavioral note — that Employee-level entities contain personal data — but says nothing about rate limits, permissions, paging behavior past 100 records, or response shape. It also restates 'read-only', which the annotations already declare.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The endpoint and personal-data warning are front-loaded and earn their place, but the 18-item entity list largely duplicates the schema enum character-for-character, making the sentence disproportionately long for the value added. Structure is functional but padded by redundancy.

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 8 parameters, no output schema and rich annotations, the definition is serviceable but leaves gaps: it does not describe the return shape (OData value array, @odata.count behavior when count=true), how paging terminates, or that valid filter/select field names differ per entity. For a generic multi-entity lister an agent would benefit from those specifics.

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%, so top, skip, count, filter, select, orderby and company_id are all documented in the schema; baseline 3 applies. The description adds no parameter meaning beyond the {company}/{entity} path template, and it simply repeats the entity enum verbatim rather than explaining anything the enum does not already convey.

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 (list) and resource (records of one of 18 named entity sets) and pins it to a concrete endpoint, GET /odata/v2.0/{company}/{entity}. The enumeration makes the tool's reach unambiguous, but it never explains how this generic catch-all relates to the dedicated sibling listers (payspace_list_employees, payspace_list_jobs, etc.), leaving that routing decision to inference.

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?

The enum constrains where the tool applies, which implies usage, but the description contains no explicit when-to-use or when-not-to-use statement and never points at the sibling list tools as alternatives. An agent must deduce from the entity names alone whether this or a dedicated lister is the right call.

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.