Skip to main content
Glama

ebay_cancel_shipment

Destructive

Cancels an eBay shipment and deletes its shipping label, refunding the total shipping cost to the billing agreement. Fails if the label has already been used.

Instructions

Cancel a shipment and delete its shipping label; eBay refunds the totalShippingCost to the billing agreement (Logistics API cancelShipment). Fails once the label has been used. Returns the shipment with its cancellation status. Logistics API is limited release (eBay-approved developers only, USPS rates and labels only) and needs the https://api.ebay.com/oauth/api_scope/sell.logistics scope, which is not requested by default: eligible keysets add it to EBAY_OAUTH_SCOPES and re-consent.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
shipmentIdYesShipment ID returned by ebay_create_shipment_from_shipping_quote

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.18.0

TDQS

A4/5.0
Behavior5/5

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

Beyond the destructive/readOnly annotations, the description discloses the refund side effect (totalShippingCost to billing agreement), label deletion, the failure condition once the label is used, the return content, and the special OAuth scope requirement. This is rich behavioral context that an agent cannot infer from structured fields alone.

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-loads the core action and its effects before the operational/eligibility boilerplate, so the essential meaning lands first. The trailing scope and re-consent details are somewhat verbose but genuinely relevant for a limited-release API.

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?

Covers action, side effects, failure condition, return value, and auth/eligibility constraints, which is everything an agent needs for a single-parameter destructive tool with no output schema. Nothing material is left unexplained.

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% and the sole parameter (shipmentId) is fully documented in the schema. The description adds no further syntax or format detail beyond what the schema already provides, so the baseline of 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 ('Cancel a shipment and delete its shipping label') and names the underlying API operation (Logistics API cancelShipment). The scope is clearly shipment-level, distinguishing it in spirit from package-level siblings like ebay_cancel_package, though it never explicitly contrasts with them.

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?

Provides one useful precondition ('Fails once the label has been used') and the eligibility restriction (limited release), which implies when the tool is usable. However, it gives no explicit guidance on when to choose this over alternatives like ebay_cancel_package or ebay_bulk_cancel_packages.

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