Skip to main content
Glama

PaySpace MCP by usefulapi

List employees

payspace_list_employees
Read-onlyIdempotent

List active employees of a company with their biographical details (name, employee number, contact, dates). Personal data. GET /odata/v2.0/{company}/Employee. Use payspace_list_all_employees to include terminated employees.

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

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, open-world behavior, so the bar is lower. The description adds real value beyond them: the result set is restricted to active employees, the payload is personal data, and the underlying OData path is disclosed. It doesn't cover default page size or rate limits, but those live in the schema.

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?

Three compact sentences, front-loaded with what the tool returns and its scope, then the sensitivity flag, the endpoint, and the sibling redirect. No filler.

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?

Covers purpose, scope restriction, PII caution, return fields, and the alternative tool — enough to invoke correctly without an output schema. Pagination and filter syntax are delegated to a well-described schema, which is reasonable.

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 top/skip/count/filter/select/orderby/company_id are already fully documented, and this is the baseline-3 case. The description adds only an indirect hint at the field vocabulary used by select/filter (name, employee number, contact, dates), nothing about syntax.

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 (List), resource (employees), and scope (active only) plus what data comes back (name, employee number, contact, dates) and the backing endpoint. The active-only qualifier and the pointer to payspace_list_all_employees make it unmistakable against both list and get siblings.

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 routes the terminated-employee case to payspace_list_all_employees, which is the main decision an agent faces here. It does not contrast with payspace_get_employee (single record) or mention paging strategy, but the list-vs-single split is inferable from the verb.

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.