Skip to main content

MCP Tool Reference

This reference documents tool names exported by the Commerce Gateway MCP handler registry.

Tool Discovery

If your org enables dynamic tool filtering, query your gateway tool discovery endpoint for the live tool set:
GET https://api.betterdata.co/gateway/{orgSlug}/tools

Tool Catalog

shop

query
string
@shop style natural-language lookup query.
intent
string
One of browse, search, lookup, price, availability.
content
array
Resolved brand/gateway guidance and routing hints.

search_products

query
string
Natural-language product query.
filters
object
Optional category/tags/price/stock filters.
limit
number
Result limit (1-20).
offset
number
Pagination offset.
content
array
Formatted product results.

get_product_details

productId
string
Product identifier.
content
array
Detailed product view and optional generated link.

check_availability

productId
string
Product identifier.
variantId
string
Optional variant identifier.
quantity
number
Requested quantity.
content
array
Buyer-safe availability signal and delivery hints.

check_inventory

productId
string
Product identifier.
variantId
string
Optional variant identifier.
locationId
string
Optional location filter.
content
array
Inventory-level stock output.

get_recommendations

productIds
array
Optional product seed list.
strategy
string
similar, complementary, trending, personalized, bundle.
limit
number
Result limit (1-10).
content
array
Recommended products.

add_to_cart

productId
string
Product identifier.
variantId
string
Optional variant identifier.
quantity
number
Quantity to add.
content
array
Updated cart and checkout-link context.

create_order

shippingAddress
object
Required address payload.
billingAddress
object
Optional billing payload.
paymentMethod
string
credit_card, paypal, apple_pay, google_pay, affirm, klarna.
content
array
Order creation result.

SCM Placeholder Tools

The following are exported and capability-gated, but depend on approved SCM adapters in runtime:
  • get_shipment_status
  • get_purchase_order_status
  • get_trace_events
  • get_demand_forecast
Tool names and schemas are verified from packages/commerce-gateway/src/mcp/tools/index.ts.