Getting started¶

More endpoints on the way

This is just the start: we're actively rolling out more MCP tools. If the endpoint you're looking for isn't here yet, check back soon, or reach out at support@helloretail.com and let us know what you need.

The Model Context Protocol (MCP) server lets AI assistants call Hello Retail APIs as tools. Supported clients include Claude (Code, Desktop, and Projects), OpenAI Codex, and ChatGPT. Ask in plain language; the assistant works out which tools to call and in what order.

What you can ask¶

"What are shoppers searching for that finds nothing?" Search analytics shows zero-result queries, top searches, and filter and sort usage.
"Why does this product show the wrong price or availability?" Product data shows what Hello Retail has indexed, and feeds show whether the last sync succeeded.
"Which fields can I filter and sort search by?" Data fields shows which product and content fields are indexed for search, and lets you toggle indexing on the fields that allow it.
"What does my search or recommendation design look like?" Search and recommendations let you read and edit templates directly.
"How are my Product Agents performing?" Product Agents analytics shows per-channel revenue, engagement rates, and a per-agent breakdown.
"What websites and configs does my account have?" Website lists everything tied to your company.

Read-only vs write tools

Most tools are read-only. Write tools trigger a confirmation prompt from your assistant before they run. The tool summary table on each page shows which is which.

Your first call¶

After connecting (see Installation & setup), ask your assistant to "list the websites for my company", then use a returned website UUID to explore its search or analytics tools.

Tips & tricks

Calls like listWebsitesForCompany need your company ID. Find it in my.helloretail.com via the profile icon (top-right) → Company Profile, in the Company Id field (see the website tools guide for a screenshot).

List the websites for company <your company ID>.

getWebsiteInfo and listWebsitesForCompany return the website UUID that every other tool needs as input.

List the websites for my company and show me each one's UUID.

Search analytics tools reveal how visitors search. Start with the top searches that return no results, since those are quick wins for synonyms or new content. See the search analytics tools for the full set.

Show the top searches with no results for my website over the last 30 days.

Tools are read-only unless their description states otherwise. Ask your assistant which write tools are available so you know what to expect when a confirmation prompt appears.

Which Hello Retail MCP tools can change data, and which are read-only?

The assistant handles OAuth login on first use and reuses the token until it expires.

Connect to the Hello Retail MCP server and confirm you can call its tools.