Skip to main content
Glama
thenavidm
by thenavidm

List all payouts

list_payouts
Read-onlyIdempotent

Retrieve a paginated list of partner program payouts, with optional filters for status, partner, group, invoice, and sorting.

Instructions

Retrieve a paginated list of payouts for your partner program.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoThe page number for pagination. The first page is `1`.
statusNoFilter the list of payouts by their corresponding status.
accountNoExact configured private workspace profile label; not a tenant or provider account ID.
sort_byNoThe field to sort the list of payouts by.amount
group_idNoFilter the list of payouts by the associated partner group. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `group_abc`, `group_abc,group_xyz`, `-group_abc`.
page_sizeNoThe number of items per page.
tenant_idNoFilter the list of payouts by the associated partner's `tenantId` (their unique ID within your database).
invoice_idNoFilter the list of payouts by invoice ID (the unique ID of the invoice you receive for each batch payout you process on Dub). Pending payouts will not have an invoice ID.
partner_idNoFilter the list of payouts by the associated partner. When specified, takes precedence over `tenantId`.
sort_orderNoThe sort order for the list of payouts.desc

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

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 fully covered by structured data. The description adds only that results are paginated, which is genuinely useful context but thin. No mention of rate limits, ordering defaults, or empty-result behavior.

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?

A single front-loaded sentence with no padding or repetition; it is efficient. It is arguably undersized relative to a ten-parameter filtering tool, but conciseness itself is not violated.

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 ten optional filter parameters, no output schema, and no annotation-level detail about the response, the description leaves the return shape and filtering capability to inference. The rich schema and annotations cover most needs, but a sentence about filtering and pagination limits would round it out.

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 each parameter is already documented in the schema, including the advanced filter syntax on group_id and the tenant_id precedence rule. The description adds nothing beyond the schema, making the baseline 3 correct.

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?

The description states a specific verb (retrieve) plus resource (payouts) and scopes it ('for your partner program'), so an agent immediately knows this is a read/list operation over payouts. It does not differentiate from any sibling, but no other payout-listing sibling exists, so the gap is minor. Clear but generic.

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 when-to-use guidance, no mention of the filtering/pagination use cases the ten parameters enable, and no named alternative or exclusion condition. The agent must infer usage entirely from the schema. Only the bare operation is described.

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