Skip to main content
Glama
thenavidm

Gumroad MCP Server

by thenavidm

Get upcoming payout

get_upcoming_payout
Read-onlyIdempotent

Retrieve the next scheduled Gumroad payout for a seller profile, with optional sales and transaction details, to review expected earnings before funds are sent.

Instructions

Get upcoming payout. Reviewed native GET /payouts/upcoming; 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.
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.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so 'Read only; no local effect approval required' largely restates structured data. The added value is the endpoint provenance and the required scope token, but nothing is said about response shape or edge cases (e.g., no upcoming payout existing).

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?

One compact sentence-pair with the purpose front-loaded and no padding. The scope/clause syntax is terse but dense with useful facts rather than filler.

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 no output schema, the description ideally would hint at what a payout response contains, but the rich parameter descriptions partially compensate. Annotations plus 100% schema coverage mean the agent can call it correctly, though the return-value side is left unaddressed.

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 all three parameters are fully documented in the schema itself, including defaults and the transaction key list. The description adds nothing beyond that, which is the baseline 3 case.

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 ('Get upcoming payout'), which is distinguishable from the sibling read tools get_payout and list_payouts by the 'upcoming' qualifier. However, it does not explicitly contrast itself with those siblings, leaving the agent to infer the distinction.

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?

It discloses the required scope ('view_payouts') and confirms the native endpoint, which is real invocation guidance, but it never says when to prefer this over list_payouts or get_payout. Usage is implied rather than directed.

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