Skip to main content
Glama

Field Service Business Platform by Doing Work

payouts_get

One payout broken down: each payment and refund in it, the processor fee and the Doing Work fee on each, and the net. The items add up to the payout amount.

Input Schema

NameRequiredDescriptionDefault
payout_idYes

Output Schema

NameRequiredDescriptionDefault
itemsYes
speedYes
statusYes
totalsYes
paid_atYes
currencyYes
fee_minorYesAmount in minor units of the currency (cents).
payout_idYes
processorYes
created_atYes
amount_minorYesAmount in minor units of the currency (cents).
arrival_dateYes
processor_refYes

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?

With no annotations, the description carries the full burden; it does disclose the response composition and a useful reconciliation invariant ('the items add up to the payout amount'), which lets an agent verify totals. It says nothing about permissions, behavior for an unknown payout_id, or whether fees can be zero/negative — meaningful gaps for an unannotated tool.

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?

Two tight sentences, front-loaded with what the payload contains and closed with the reconciliation rule. Nothing is repeated from structured fields and no sentence is 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?

An output schema exists, so return shape need not be restated, and the description nevertheless frames what an agent will receive. The only real gap is the missing path to obtaining a valid payout_id and any error semantics, which are minor for a single-parameter read.

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 0%, so the sole parameter payout_id is undocumented in both schema and description — the definition never says whether it is the internal payout id from payouts_list or a processor-side identifier. The name is largely self-explanatory and the tool takes only one parameter, which keeps this from being worse than a 3.

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?

It conveys a specific resource scope — a single payout with its constituent payments, refunds, per-item processor and Doing Work fees, and net — which is clearly distinct from the list operation named payouts_list. The retrieval verb is only implied by the tool name rather than stated, and the sibling is never named explicitly, so it stops short of a 5.

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 statement of when to call this versus payouts_list or the fee/report siblings (fees_statement, reports_revenue), and no note that a payout_id must first be obtained from payouts_list. The only guidance is implicit in the singular 'One payout' phrasing.

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.

Resources