Skip to main content
Glama
Pletopay MCP Server

Pletopay MCP Server

Official
by pletopay

Retrieve a settlement

get_settlement
Read-onlyIdempotent

Retrieve a settlement by its stl_… ID to view associated fees and the payout transfer’s status.

Instructions

Retrieve a settlement.

Retrieve a settlement by id (stl_…), including its fees and the payout transfer’s status.

Input Schema

NameRequiredDescriptionDefault
idYesThe settlement id (`stl_…`).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, openWorldHint=false and destructiveHint=false, so the safety profile is covered. The description usefully adds that the response includes fee data and the payout transfer's status, which is real value given no output schema, but it says nothing about behavior for an unknown or malformed id.

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, front-loaded sentences with no filler, though the opening 'Retrieve a settlement.' duplicates the title and the first clause of the following sentence, which is mild redundancy.

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 one-parameter read tool with no output schema, the description covers what it returns (fees, payout transfer status), which compensates for the missing output schema. Only error/not-found behavior and pagination-free confirmation are absent, both minor here.

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 the single param already documents the 'stl_…' format, so the description merely repeats it. Baseline 3 is appropriate since the schema carries the parameter semantics.

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 ('Retrieve a settlement by id') and adds the id prefix format and the payload contents (fees, payout transfer status). It does not name a sibling such as list_settlements or list_settlement_items as the way to obtain an id, so the boundary is only implied.

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 the 'by id (stl_…)' requirement – the agent infers it needs a settlement id already in hand – but there is no explicit when-to-use versus list_settlements/list_settlement_items, and no stated fallback when the id is unknown.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools