Built-in tools
The MCP tools each starting template brings, read from the code on every release.
A company starts from a template. The template decides which tools its assistant has before the team changes
anything. Your team can turn tools off and add its own actions in the console, so your company's live list may
differ. tools/list on your endpoint always returns the current set.
This page is generated from the assistant's code each time the docs are built.
Arguments every tool takes
Besides its own arguments, which are listed with each tool below, every tool takes these. tools/list includes
them in each tool's input schema.
| Argument | Type | Description |
|---|---|---|
request_intent (required) | string | One short sentence, in the customer’s words, about what they are trying to do with this request. At least 8 characters. |
conversation_goal (required) | string | The goal of the whole conversation, in the customer’s words. Send the same sentence on every call of a chat. At least 8 characters. |
conversation_id | string | Omit it on the first call of a new chat. Every reply returns a `conversation_id`; send it back on every later call of that chat. |
General
Every company's assistant can answer questions about the company.
ask
Ask a question · Works for guests · Reads only
Ask the company’s assistant a question on the customer’s behalf — about the company, its services, opening hours, policies or the customer’s own matters — and get an answer to relay.
| Argument | Type | Description |
|---|---|---|
question (required) | string | The customer’s question, in their own words. |
Commerce
Companies that sell online also get catalog, cart, checkout and account tools.
get_my_account
My account · Needs a signed-in customer · Reads only
The logged-in customer's profile: name, tier, email, shipping address and order count.
search_products
Search products · Works for guests · Reads only
Search the catalog by free text. Returns price, sale price, variants, rating and best-seller status.
| Argument | Type | Description |
|---|---|---|
query | string | Free text, e.g. a product name or category. |
category | string | Optional catalog category to filter by. |
limit | number | Max results (default 10). |
list_deals
Deals · Works for guests · Reads only
List products currently on sale (with a struck "was" price) — the best discounts first.
list_bestsellers
Best sellers · Works for guests · Reads only
List the best-sellers.
get_product
Product detail · Works for guests · Reads only
Full detail for one product by id: price, sale price, variants, rating and reviews.
| Argument | Type | Description |
|---|---|---|
product_id (required) | string |
check_personal_offer
Check my offer · Needs a signed-in customer · Reads only
Check whether there is a personal offer waiting for THIS logged-in customer right now, and return it. Eligibility is per member, so the answer may be no. Product listings name this as their nextStep — call it after showing products, having told the customer you are checking. Announce that you are checking, never what the offer is: you do not know until this answers.
| Argument | Type | Description |
|---|---|---|
focus | string | What the customer was just looking at — the offer is built around it. |
claim_welcome_gift
Welcome gift · Needs a signed-in customer · Makes changes
Reveal and hand over the club member's one-time WELCOME GIFT — a starter bundle at an extra members-only discount plus a free gift. Product listings name this as their nextStep when the member has a welcome. Warmly congratulate the customer first; this tool answers whether the gift is available and, when it is, returns it ready to add to the bag with add_bundle_to_cart.
add_bundle_to_cart
Add bundle to bag · Works for guests · Makes changes
Add every item of a personalised bundle to the bag in one call. Wired to the bundle widget CTA.
| Argument | Type | Description |
|---|---|---|
product_ids (required) | array | The bundle's product ids. |
list_categories
Categories · Works for guests · Reads only
List the catalog categories.
add_to_cart
Add to bag · Works for guests · Makes changes
Add a product to the bag by product_id, with an optional variant (colour or size — defaults to the product's first variant) and quantity. Returns the updated bag with shipping and free-gift progress.
| Argument | Type | Description |
|---|---|---|
product_id (required) | string | Product id (from search_products / list_deals). |
variant | string | Variant name — a colour or size. Optional. |
quantity | number | Default 1. |
view_cart
View bag · Works for guests · Reads only
The customer's current bag: lines with variants, subtotal, shipping, free-gift progress and total.
update_cart_quantity
Update quantity · Works for guests · Makes changes
Set the quantity of a bag line (0 removes it). Pass the variant to target a specific one.
| Argument | Type | Description |
|---|---|---|
product_id (required) | string | |
quantity (required) | number | |
variant | string | Optional variant to target. |
remove_from_cart
Remove from bag · Works for guests · Makes changes
Remove a product (or a specific variant) from the bag.
| Argument | Type | Description |
|---|---|---|
product_id (required) | string | |
variant | string |
checkout
Checkout · Works for guests · Makes changes
Place the order for the current bag. Applies the shipping terms (free over the threshold). Optionally pass a shipping address (defaults to the account address). Returns the confirmed order.
| Argument | Type | Description |
|---|---|---|
address | string | Shipping address (optional). |
list_orders
My orders · Needs a signed-in customer · Reads only
The customer's orders, newest first, with number, status, total and ETA.
get_order
Order detail · Needs a signed-in customer · Reads only
Full detail for one order by id or number.
| Argument | Type | Description |
|---|---|---|
order_number (required) | string |
add_to_wishlist
Add to wishlist · Needs a signed-in customer · Makes changes
Save a product to the customer's wishlist (♥) by product_id or free-text query.
| Argument | Type | Description |
|---|---|---|
product_id | string | |
query | string |
remove_from_wishlist
Remove from wishlist · Needs a signed-in customer · Makes changes
Remove a product from the customer's wishlist (♥).
| Argument | Type | Description |
|---|---|---|
product_id (required) | string |
recommend_for_me
Recommended for you · Needs a signed-in customer · Reads only
Complementary products picked for the customer — personalised from their order history, wishlist and current bag. Also surfaced automatically on the order confirmation. Great to offer at checkout.
| Argument | Type | Description |
|---|---|---|
limit | number | Max suggestions (default 4). |
list_wishlist
My wishlist · Needs a signed-in customer · Reads only
The customer's saved wishlist products (♥).
create_gift_list
Create gift list · Needs a signed-in customer · Makes changes
Create the customer's shareable gift list — a list they add products to and share with family and friends via a public link, so others can buy from it. Seeds from the current wishlist by default. Idempotent: returns the existing gift list if they already have one. Product listings offer it (in `nextStep` or `moreSteps`) while the customer has none yet.
| Argument | Type | Description |
|---|---|---|
title | string | List name. Optional. |
due_date | string | Expected due date (ISO), optional. |
include_wishlist | boolean | Seed the gift list from the current wishlist (default true). |
add_to_gift_list
Add to gift list · Needs a signed-in customer · Makes changes
Add a product to the customer's gift list by product_id or free-text query. Creates the gift list first if they don't have one yet.
| Argument | Type | Description |
|---|---|---|
product_id | string | |
query | string |
remove_from_gift_list
Remove from gift list · Needs a signed-in customer · Makes changes
Remove a product from the customer's gift list.
| Argument | Type | Description |
|---|---|---|
product_id (required) | string |
view_gift_list
My gift list · Needs a signed-in customer · Reads only
The customer's gift list with its items and the shareable link to send to family and friends. Says so if they have not created one yet.