Skip to main content
Glama

ebay_get_payout_summary

Read-only

Get cumulative eBay payout totals—payout count, transaction count, and total amount—from the Finances API, optionally filtered by date range and payout status.

Instructions

Get cumulative payout totals from the eBay Finances API: payout count, related transaction count, and total amount, optionally filtered by payoutDate range and one payoutStatus. Requires the sell.finances scope. eBay requires Digital Signatures on Finances API calls for EU/UK sellers; set EBAY_SIGNING_KEY_JWE and EBAY_SIGNING_PRIVATE_KEY to sign them.

Input Schema

NameRequiredDescriptionDefault
filterNoPayout summary 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). Separate multiple criteria with commas. eBay summarizes payouts in all states from the last five years when omitted.
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.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description adds meaningful operational context: the sell.finances scope requirement and the EU/UK Digital Signatures requirement with the relevant environment variables. It does not mention rate limits or return format, but with annotations covering safety this is a strong disclosure.

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?

The description is front-loaded with the tool's purpose, then adds scope and signing requirements. It is appropriately sized with no obvious filler, though the first sentence is somewhat dense.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, the description identifies the returned summary metrics, notes the available filtering, and covers the scope and signing prerequisites. An agent has enough information to invoke the tool correctly without additional context.

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 input schema already documents filter syntax, status values, date-range limits, and marketplaceId behavior. The description mentions payoutDate and payoutStatus filtering but does not add syntax or semantics beyond what the schema provides.

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 and resource: 'Get cumulative payout totals from the eBay Finances API,' and names the returned metrics. It is clear what the tool does, though it does not explicitly distinguish itself from related siblings such as ebay_get_payouts or ebay_get_transaction_summary.

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 gives useful context by noting the optional payoutDate and payoutStatus filtering plus the required sell.finances scope. However, it does not explicitly say when to choose this tool over the related payout, transaction, or seller-funds summary tools.

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