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. You can ask about a website's search, feeds, recommendations, and analytics in plain language.
What you can do¶
Look up a website's configuration, inspect product feeds and recent product changes, read search analytics (top searches, no-result queries, filter and sorting usage), and review recommendation and search designs.
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.
getWebsiteInfo and listWebsitesForCompany return the website UUID that every other tool needs as input.
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.
Tools are read-only unless their description states otherwise.
The assistant handles OAuth login on first use and reuses the token until it expires.