Skip to content
Orderboost
Esc
navigateopen⌘Jpreview
On this page

Use Orderboost MCP tools

Reference Orderboost's public catalog tools, protected cart and checkout operations, companion authentication, and payment-authorized completion.

Orderboost’s global Model Context Protocol (MCP) resource combines public catalog discovery with protected commerce operations. Tool results use authoritative checkout state and revision data.

Catalog tools

Catalog tools do not require OAuth:

Tool Purpose
search_catalog Search active registered merchants without a product URL
lookup_catalog Resolve an exact canonical product URL or identifier
get_product Read product details and complete missing option selections

Protected checkout tools

Protected tools require MCP OAuth:

Tool Purpose
create_cart Create agent-owned mutable cart state
get_cart Read the current cart and revision
update_cart Change allowed cart fields before checkout
cancel_cart Cancel a cart with one stable idempotency key
create_checkout Quote and create an agent-owned checkout
get_checkout Read status, revision, approval URL, and grant state
update_checkout Fully replace mutable checkout input at the expected revision
cancel_checkout Cancel a checkout owned by the authenticated actor
claim_checkout_handoff Claim an existing browser checkout with a one-time handoff code

Create checkout from an exact URL

Global MCP resolves the merchant from the canonical variant URL returned by catalog search or lookup. Do not send a merchant slug or private platform identifier.

Call lookup_catalog with the storefront URL. Pass the returned canonical variant URL to create_checkout. Your MCP client reads each tool’s current argument schema during discovery.

Read the Orderboost checkout from structuredContent. Treat its revision, status, line items, and total as authoritative.

Follow the status loop

Status Required action
incomplete Resolve recoverable messages, then replace mutable input with update_checkout
requires_escalation Show the exact continue_url and wait for buyer review
ready_for_complete Read the purchase grant and complete once
complete_in_progress Poll get_checkout with bounded backoff
completed Require and report the persisted order
canceled Stop without creating another checkout unless the user asks

requires_escalation is an expected buyer-approval state, not an unpayable checkout. Present the URL instead of asking for payment credentials, offering cancellation, or claiming that the agent cannot continue.

Payment-authorized completion

complete_checkout requires more than OAuth. The checkout must be ready_for_complete, and the signed-in approver must have issued an exact purchase grant for the current revision.

Send one stable idempotency key and the purchase grant returned for the approved revision. Orderboost uses the grant’s tokenized payment reference, so the agent never handles payment credentials.

Reuse that idempotency key only when retrying the same completion after an ambiguous response. Fetch current checkout state before authorizing any second attempt.

Companion authentication tools

begin_orderboost_auth and complete_orderboost_auth exist only on the local orderboost-mcp companion. They do not appear on the direct remote MCP server.

Use the host’s native OAuth action when those tools are absent. Do not retry catalog search to make companion tools appear.

Was this page helpful?