Skip to main content
Glama
thenavidm

Gumroad MCP Server

by thenavidm

Get payout

get_payout
Read-onlyIdempotent

Retrieve a specific payout by ID to inspect payout status, amount, and optional sales or transaction details for accounting review.

Instructions

Get payout. Reviewed native GET /payouts/:id; scope: view_payouts. Read only; no local effect approval required.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountNoExact private profile label; never inherited credentials, ownership or scope proof.
payout_idYesExact opaque provider ID, including native = padding.
include_salesNo(optional, default: "true") - Set to "false" to exclude the "sales", "refunded_sales", and "disputed_sales" details from the response.
include_transactionsNo(optional, default: "false") - Set to "true" to include the same transaction details in the response as exported payout CSV. All balance-affecting transactions included in the payout will be listed in a "transactions" array. Each transaction will have these keys: { type:, date:, purchase_id:, item_name:, buyer_name:, buyer_email:, taxes:, shipping:, sale_price:, gumroad_fees:, net_total: }. The "type" of transactions can be "Sale", "Chargeback", "Full Refund", "Partial Refund", "PayPal Refund", "Stripe Connect Refund", "Affiliate Credit", "PayPal Connect Affiliate Fees", "Stripe Connect Affiliate Fees", "PayPal Payouts", "Stripe Connect Payouts", "Credit", "Payout Fee", and "Technical Adjustment".

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is covered. The description adds value beyond that by disclosing the required auth scope (view_payouts) and that no local effect approval is needed, which is real operational context an agent cannot get 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?

Very short and front-loaded, with the resource, scope and read-only nature stated up front. Nothing is wasted, though the opening sentence duplicates the name and the approval clause is slightly cryptic.

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 simple single-resource GET with no output schema, full schema coverage and annotations covering safety, the description supplies the remaining essentials: the endpoint and the required scope. It is adequate, though it omits error/not-found behavior and sibling differentiation.

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 the four parameters (account, payout_id, include_sales, include_transactions) are already fully documented, including defaults and response-shaping behavior. The description adds nothing about parameters, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence 'Get payout' merely restates the name and title, which is tautological. The second clause adds the native endpoint GET /payouts/:id, confirming this is an ID-based fetch, but it never distinguishes itself from close siblings like list_payouts or get_upcoming_payout.

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?

The description names the required scope (view_payouts), which implies a precondition, but it gives no guidance on when to use this tool versus get_upcoming_payout or list_payouts. There is no when/when-not framing at all.

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