Skip to main content
Glama

List Payouts

list_payouts
Read-onlyIdempotent

List recent payouts for the current account, newest first, with each affiliate's name. A payout groups an affiliate's commissions for payment and has its own state, separate from its commissions' states. The totals object covers every payout matching the id/affiliate_id/state filters across all pages, with amounts per currency and state. by_affiliate lists at most 100 affiliate/currency groups selected by amount; this is not a cross-currency ranking. Check by_affiliate_truncated for omitted groups. Overall currency totals include every match.

Input Schema

NameRequiredDescriptionDefault
idNoFilter by exact record ID.
pageNo
limitNo
stateNo
affiliate_idNo

Output Schema

NameRequiredDescriptionDefault
okYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already cover the read-only/idempotent safety profile, but the description adds real operational context: totals aggregate across all pages rather than the current page, by_affiliate is capped at 100 groups selected by amount and is not a cross-currency ranking, and by_affiliate_truncated flags omissions. This pagination/truncation behavior is not derivable from the annotations.

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?

Purpose is front-loaded in the first sentence, followed by tightly packed semantic notes about totals and by_affiliate. It is dense but every sentence carries information about behavior or result shape; 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?

With an output schema present and annotations covering safety, the description's remaining burden is result-shape nuance, which it handles well (totals scope, truncation flag). The main gap is call-time guidance for filtering/paging parameters, which is minor for a read-only list tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is only 20%, so the description must compensate, and it names the id/affiliate_id/state filters only collectively. It says nothing about page/limit behavior (e.g. max limit of 50, paging interaction with totals) or the format/semantics of the id filters, leaving the low-coverage parameters largely undocumented.

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+resource ('List recent payouts for the current account'), adds ordering ('newest first') and an included field ('each affiliate's name'). It also distinguishes itself from list_commissions by explaining that a payout has its own state separate from its commissions' states.

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 semantics (payouts vs commissions) but there is no explicit 'use this when…' statement, no prerequisites, and no named alternative among the large set of list_* siblings. An agent can infer the context but is not routed to it.

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