Skip to main content
Glama

PaySpace MCP by usefulapi

List regions

payspace_list_regions
Read-onlyIdempotent

List the company's regions. GET /odata/v2.0/{company}/CompanyRegion.

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.
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.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds the concrete OData path, which is useful but thin; it says nothing about pagination defaults, page-size limits, or result ordering that would help an agent drive the six query parameters.

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 purpose front-loaded and no filler. The endpoint path is slightly redundant with the annotations but does add locational context, so nothing is wasted outright.

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 six optional parameters, no output schema and a mutation-free profile already covered by annotations, this is minimally adequate. It never states what fields a region record contains or how many records to expect, so an agent must rely entirely on the schema and vendor docs.

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%, and each parameter already carries its own OData explanation and examples, so the baseline of 3 applies. The description contributes no additional parameter meaning or cross-parameter guidance (e.g. how top/skip interact, or when count is worth requesting).

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 the company's regions') plus the underlying endpoint, so the agent knows exactly what entity is returned. It doesn't explicitly contrast with siblings, but the resource noun ('regions') is distinct from every sibling in the list, so confusion risk is low.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no guidance on when to use this tool, no prerequisites, and no mention of alternatives. The only implicit cue is that it is a plain list endpoint rather than a filtered lookup, which the agent must infer from 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.