Skip to main content
Glama

ebay_get_payout

Read-only

Retrieves a single seller payout from the eBay Finances API by payout ID, returning amount, status, payout instrument, and transaction count for reconciliation and reporting.

Instructions

Get one seller payout by payoutId from the eBay Finances API, including amount, status, payout instrument, and transaction count. Find IDs with ebay_get_payouts. 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
payoutIdYesPayout ID from ebay_get_payouts or Seller Hub. A split-payout payoutReference returns 404.
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

A4.5/5.0
Behavior5/5

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

Annotations only declare readOnlyHint=true, while the description adds crucial behavioral context: required OAuth scope, EU/UK digital-signature requirements, and the environment variables needed for signing. It also lists key payout fields returned, which helps the agent understand what the call provides.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three compact sentences with no filler, leading with what the tool returns and then covering ID sourcing and prerequisites. Every sentence contributes useful information.

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?

For a read-only financial lookup with no output schema, the description is complete enough: it names the returned fields, explains how to get the required ID, and discloses scope and signing prerequisites. Nothing essential for correct invocation appears missing.

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 both payoutId and marketplaceId are already well documented in the schema. The description adds little parameter-level meaning beyond noting that IDs come from ebay_get_payouts, which is already stated in the schema.

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

Purpose5/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 one seller payout') and identifies the source API and returned fields. It also distinguishes this single-payout tool from the sibling list tool by pointing to ebay_get_payouts for IDs.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It clearly explains how to obtain the required payoutId via ebay_get_payouts and states the required sell.finances scope. It also gives the important EU/UK digital-signature prerequisite, though it does not explicitly state when not to use this tool versus every other sibling.

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