Skip to main content
Glama

ebay_get_payouts

Read-only

List eBay seller payouts over the past five years; filter by payout date or status, then paginate or sort results for finance reconciliation.

Instructions

List seller payouts from the eBay Finances API (last five years). Filter by payoutDate range and/or payoutStatus, page with limit/offset, sort by payoutDate. Returns a success status with no data when nothing matches. Requires the sell.finances scope. eBay requires Digital Signatures on Finances API calls for EU/UK sellers, which this server does not add.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sortNoSet to payoutDate (or lastAttemptedPayoutDate for retryable failures) for oldest first. eBay sorts newest first by default.
limitNoRecords per page, up to 200 (eBay default 20)
filterNoPayout filter. Criteria: payoutDate:[2024-12-17T00:00:01.000Z..2024-12-24T00:00:01.000Z] (within the last five years, range up to 36 months); payoutStatus:{SUCCEEDED} (one PayoutStatusEnum value, e.g. INITIATED, SUCCEEDED, RETRYABLE_FAILED, TERMINAL_FAILED, REVERSED); lastAttemptedPayoutDate:[start..end] (requires payoutStatus:{RETRYABLE_FAILED}); payoutReference:{5********3} (mainland China sellers only). Separate multiple criteria with commas. eBay returns payouts in all states from the last five years when omitted.
offsetNoZero-based number of payouts to skip; keep below 5000 for response time (eBay default 0)
marketplaceIdNoOverrides the X-EBAY-C-MARKETPLACE-ID header, e.g. EBAY_US, EBAY_GB or EBAY_DE. Defaults to EBAY_MARKETPLACE_ID; eBay assumes EBAY_US when the header is absent.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.18.0

TDQS

A3.7/5.0
Behavior4/5

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

Beyond the readOnlyHint annotation, the description discloses real operational constraints: the required sell.finances scope, the fact that EU/UK Finances calls need Digital Signatures this server does not add (a silent-failure risk), and that empty results return a success status with no data. Rate limits and response shape are not covered, but the auth and edge-case disclosures are genuinely useful.

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?

Front-loaded with the core action and resource, then scope/filters/edge cases in short clauses. Some sentences restate schema content (filters, paging, sort), so it is efficient but not maximally tight.

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 no output schema, the description carries the return burden and does note the empty-result success behavior; it also covers auth scope and the Digital Signature limitation. It stops short of describing pagination totals or the full payout object, but an agent has enough to invoke it correctly.

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 schema already documents all five parameters in detail. The description only summarizes the same filters (payoutDate range, payoutStatus, limit/offset, sort by payoutDate), adding no syntax or edge-case detail beyond the schema. Baseline 3 applies.

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 (List seller payouts) plus the source API and the five-year window. It does not explicitly route against the closest siblings (ebay_get_payout singular, ebay_get_payout_summary, ebay_get_transactions), so it is clear but not fully differentiated.

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?

Filter and paging options are described, but there is no explicit when-to-use or when-not guidance and no named alternative among the many payout/transaction siblings. Usage is implied rather than stated.

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

Deploy Server

Other Tools