Skip to main content
Glama

ebay_get_order_earnings_summary

Read-only

Retrieve aggregated order earnings from the eBay Finances API for orders created within a date range, defaulting to the past year. Use date filters to summarize earnings for reporting.

Instructions

Get aggregated order earnings from the eBay Finances API for orders created in an orderCreationDate range (defaults to the past year). Requires the optional https://api.ebay.com/oauth/api_scope/sell.finances.earnings.read scope, which is not requested by default: add it to EBAY_OAUTH_SCOPES and re-run OAuth consent. eBay grants it only to approved US, CN, or HK sellers with USD payouts. 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
filterNoOrder creation date range in UTC; orderCreationDate is the only supported filter, e.g. orderCreationDate:[2024-10-23T00:00:01.000Z..2024-11-09T00:00:01.000Z]. eBay returns the past year 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

A4.1/5.0
Behavior5/5

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

Well beyond the readOnlyHint annotation, the description discloses prerequisites an agent cannot discover elsewhere: the sell.finances.earnings.read scope is not requested by default and requires adding to EBAY_OAUTH_SCOPES plus re-running consent, eBay grants it only to approved US/CN/HK sellers with USD payouts, and EU/UK sellers must configure EBAY_SIGNING_KEY_JWE and EBAY_SIGNING_PRIVATE_KEY for Digital Signatures. That is exactly the kind of failure-mode context annotations cannot carry.

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 purpose, then defaults, then the auth/eligibility/signing requirements in decreasing priority. The sentences are dense and slightly run-on with nested parenthetical caveats, but essentially every clause carries operational 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, two-parameter tool with full schema coverage and no output schema, this covers everything an agent needs: what it returns (aggregated earnings), scope setup, seller eligibility, and the signing requirement for EU/UK. No material gap remains.

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 coverage is 100%, so both parameters (filter and marketplaceId) are already fully documented with examples. The description's mention of the orderCreationDate range and past-year default restates the schema rather than adding syntax or constraint detail, so the 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: 'aggregated order earnings from the eBay Finances API for orders created in an orderCreationDate range'. This is clearly distinguishable from ebay_get_order_earnings and ebay_get_order_earnings_by_id by the word 'aggregated', but the description never explicitly names those siblings or states how the result differs from the per-order endpoints.

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?

Gives solid usage context: the default when the filter is omitted (past year) and the eligibility gates (approved US/CN/HK sellers with USD payouts). It does not state when an agent should prefer this summary over the sibling per-order earnings tools, leaving that routing to the name alone.

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