MCP Reference

MCP Tools

The tools the SearchX MCP server exposes to a connected assistant. The model calls them automatically, so you never invoke them by hand.


search_products

Full-text search over the merchant's catalog.

  • query (required): the shopper's search text, e.g. "running shoes with good cushioning".
  • limit (optional): max products to return (default 10).
  • filter (optional): a catalog filter expression, e.g. price < 120 or color = 'navy'.

Returns a list of products (title, price, url, brand, color, image).


search_by_intent

Semantic search by meaning rather than exact keywords. Best when the shopper describes a need, occasion, or vibe, such as "something warm for hiking in the rain", "a gift for a 5-year-old who loves dinosaurs".

  • query (required): the shopper's intent in natural language.
  • limit (optional): max products to return (default 10).
  • filter (optional): catalog filter expression.

Returns matching products in the same shape as search_products.


get_product_details

Fetch the full details of a single product.

  • id (required): the product id, as returned in the id field of a search result.

Returns one product, or a not-found message.


find_alternatives

"More like this": products similar to a given one.

  • productId (required): the id of the product to find alternatives for.
  • limit (optional): max alternatives to return (default 10).

Returns a list of similar products.


check_availability

Check whether products are currently in stock.

  • product_id (optional): check one specific product, using the id from a search result. Takes precedence over query when both are given.
  • query (optional): check availability across everything matching a search, e.g. "navy running shoes".
  • limit (optional): with query, how many products to check (default 10).
  • in_stock_only (optional): with query, return only products known to be in stock.

Give it either product_id or query.

Each result reports availability as one of three values:

ValueMeaning
in_stockThe catalog says the product is available.
out_of_stockThe catalog says the product is unavailable.
unknownYour product feed publishes no availability for this product.

unknown is not the same as out of stock. It means SearchX was never told, so the assistant is instructed to say the stock status could not be confirmed rather than implying the product is unavailable. If you see unknown across your catalog, add an availability field to your product feed.

With a query, the response also includes a counts summary of how many products fall into each state.


compare_products

Fetch several products and return a side-by-side comparison.

  • ids (required): 2 to 5 product ids to compare.

Returns each product plus a per-field comparison (title, price, brand, color) noting where they differ.


ask_about_searchx

Answers questions about the SearchX product itself: what it is, the company, features, pricing, and how to integrate it. Use this for product questions, not catalog search.

  • question (required): the user's question about SearchX.
  • topic (optional): about, docs, faq, or all (default).

Clean results only

Every product the assistant receives is stripped of internal fields, so it only sees useful, non-leaky data (title, price, url, brand, color, image).

Previous
Authentication