UCP Gateway

shopping checkout cancel

shopping_checkout_cancel

Cancel an active merchant checkout using an idempotency key.

Input Schema

TableJSON Schema

Name	Required	Description
`agent_id`	Yes	Registered UCP Gateway UUID returned by register_ucp_profile; required for every Shopping tool.
`checkout_id`	Yes	Provider checkout ID to cancel.
`idempotency_key`	No	Optional UUID idempotency key for the cancel request; reuse only for retrying the same cancellation.
`merchant_domain`	Yes	Merchant host such as 'outboundpower.com' or 'example.myshopify.com'. Do not include a URL scheme, localhost, private IP, file URL, or ftp URL.
`client_action_id`	No	Optional UUID generated once for an explicit buyer/operator-confirmed cart or checkout mutation. Reuse only when retrying the same confirmed action.

Output Schema

TableJSON Schema

Name	Required	Description
`ok`	Yes	True for successful tool execution; false for structured tool errors.
`raw`	No	Redacted raw provider or registry payload for debugging. Shape may vary by upstream endpoint.
`error`	No	Structured tool error.
`message`	Yes	Human-readable result summary or recovery message.
`checkout`	No	Safe provider checkout summary including id, status, continue_url, totals, line_items, and messages when provided.
`warnings`	No	Non-fatal checkout or handoff warnings.
`next_step`	Yes	Recommended next step. Suggestions are non-binding and never authorize payment or state-changing actions.
`merchant_domain`	No	Resolved merchant domain.
`partial_success`	No	True when Shopify flagged the upstream result as an error but returned a usable checkout payload (id plus continue_url or recognized status). The gateway result is still actionable; this is not an order confirmation.
`upstream_is_error`	No	True when the upstream Shopify MCP response set isError/ok:false while still returning a usable checkout payload. Present for debugging; does not make the gateway tool result an error.
`commerce_session_id`	No	Internal gateway commerce session UUID when one was created.
`requires_escalation`	No	True when Shopify requires the buyer to finish a step on the merchant-hosted checkout page (status requires_escalation/requires_buyer_input or escalation warnings). The continue_url is still actionable.

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedJun 26, 2026

addedOutput schema / properties / partial_success

Added value: +{
+  "description": "True when Shopify flagged the upstream result as an error but returned a usable checkout payload (id plus continue_url or recognized status). The gateway result is still actionable; this is not an order confirmation.",
+  "type": "boolean"
+}

addedOutput schema / properties / requires_escalation

Added value: +{
+  "description": "True when Shopify requires the buyer to finish a step on the merchant-hosted checkout page (status requires_escalation/requires_buyer_input or escalation warnings). The continue_url is still actionable.",
+  "type": "boolean"
+}

addedOutput schema / properties / upstream_is_error

Added value: +{
+  "description": "True when the upstream Shopify MCP response set isError/ok:false while still returning a usable checkout payload. Present for debugging; does not make the gateway tool result an error.",
+  "type": "boolean"
+}

First observedJun 5, 2026

TDQS

A3.7/5.0

Behavior3/5

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

Annotations show readOnlyHint=false and destructiveHint=false. The description says 'cancel', which implies state change, but does not explain side effects, idempotency behavior beyond the key, or what happens if already cancelled. With annotations present, the description adds minimal behavioral context.

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 a single, front-loaded sentence with no wasted words. Every word adds essential meaning.

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

Completeness3/5

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

The tool has an output schema, so return values are covered. However, the description lacks details about prerequisites (e.g., checkout must be active), idempotency behavior, and what constitutes success/failure. It is minimally adequate but not comprehensive.

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 parameters. The description only adds 'using an idempotency key', hinting at that parameter but not adding significant meaning beyond the schema. Baseline 3 is appropriate.

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 clearly states the tool cancels an active merchant checkout using an idempotency key. It uses a specific verb and resource, and the context distinguishes it from checkout create/get/update siblings.

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?

The description mentions using an idempotency key but does not explicitly state when to use this tool versus alternatives like shopping_cart_cancel or how to ensure the checkout is active. Usage is implied rather than directed.

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

All UCP Gateway tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources

Need Help?