Search¶

Inspect a website's search configuration: synonyms, stop words, search configs, and the rendered search designs.

Tips & tricks

Synonyms expand a query, so a search for the word also returns results matching the synonym.

Show the search synonyms configured for my website and what each one expands to.

Stop words are stripped before search runs. Use them to drop noise words that dilute results.

List the search stop words for my website and suggest any noise words I should add.

getSearchDesign¶

Retrieve the design fields (templates, styles, initialization code) of a search configuration for a customer website using Hello Retail. Returns the draft version if one exists, otherwise the LIVE version. Use this before updateSearchDesign to read the current state of the design.

Name	Type	Required	Description
`websiteUuid`	string	Yes	The UUID of the customer's website in Hello Retail. Use `getWebsiteInfo` to look up available websites, or find it in my.helloretail.com under Settings → Website Settings → Website Unique Id.
`key`	string	Yes	The stable key of the search config. Use `listSearchConfigs` to find available keys.

Example request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "getSearchDesign",
    "arguments": {
      "websiteUuid": "<string>",
      "key": "<string>"
    }
  }
}

Returns

{
  "key": "<string>",
  "name": "<string>",
  "state": "<string>",
  "inputTemplate": "<string>",
  "initializationCode": "<string>",
  "resultTemplate": "<string>",
  "resultStyles": "<string>"
}

updateSearchDesign¶

Update the design fields (templates, styles, initialization code) of a search configuration for a customer website using Hello Retail. Directly edits any config that is in INTERNAL_REVIEW or REVIEW state; if no editable config exists, creates a new draft from the current LIVE config and applies the edits to it. All parameters are optional and updates are partial: omitted fields are left unchanged. Publishing is not possible through this tool.

Name	Type	Required	Description
`websiteUuid`	string	Yes	The UUID of the customer's website in Hello Retail. Use `getWebsiteInfo` to look up available websites, or find it in my.helloretail.com under Settings → Website Settings → Website Unique Id.
`key`	string	Yes	The stable key of the search config to update. Use `listSearchConfigs` to find available keys.
`inputTemplate`	string	No	HTML template for rendering the search input field on the page.
`initializationCode`	string	No	JavaScript run when the search UI initialises.
`resultTemplate`	string	No	HTML/Liquid template used to render search results.
`resultStyles`	string	No	CSS styles applied to the search result container.

Example request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "updateSearchDesign",
    "arguments": {
      "websiteUuid": "<string>",
      "key": "<string>"
    }
  }
}

Returns

{
  "key": "<string>",
  "draftId": 0,
  "name": "<string>",
  "state": "<string>",
  "lastModified": "<string>"
}

listSearchConfigs¶

List search configurations for a customer website using Hello Retail. Each configuration represents a search UI instance (e.g. a full-page search, an instant/autocomplete search, or an overlay). One entry is returned per key; when a key has multiple lifecycle versions the editable version (INTERNAL_REVIEW or REVIEW) takes priority, then LIVE, then archived. The key is the stable identifier used as the key parameter when executing searches against https://core.helloretail.com/serve/search — it does not change across config revisions. The type is one of: Full search, Instant search, Overlay search, Other. The state reflects the configuration's lifecycle: INTERNAL_REVIEW (internal draft), REVIEW (awaiting business approval), LIVE (serving users), or ARCHIVED/INTERNAL_ARCHIVED. The draft flag indicates this is an unpublished draft of an existing LIVE configuration.

Name	Type	Required	Description
`websiteUuid`	string	Yes	The UUID of the customer's website in Hello Retail. Use `getWebsiteInfo` to look up available websites, or find it in my.helloretail.com under Settings → Website Settings → Website Unique Id.

Example request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "listSearchConfigs",
    "arguments": {
      "websiteUuid": "<string>"
    }
  }
}

Returns

[
  {
    "key": "<string>",
    "name": "<string>",
    "type": "<string>",
    "state": "<string>",
    "draft": false,
    "lastModified": "<string>"
  }
]

listSearchStopWords¶

List all search stop words for a customer website using Hello Retail. Stop words are stripped from the visitor's query before search is executed — useful for filtering out noise words (e.g. "and", "the", "with") that would otherwise dilute results. Stop words are stored and matched case-insensitively and are configured per website.

Name	Type	Required	Description
`websiteUuid`	string	Yes	The UUID of the customer's website in Hello Retail. Use `getWebsiteInfo` to look up available websites, or find it in my.helloretail.com under Settings → Website Settings → Website Unique Id.

Example request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "listSearchStopWords",
    "arguments": {
      "websiteUuid": "<string>"
    }
  }
}

Returns

["<string>"]

listSearchSynonyms¶

List all search synonyms for a customer website using Hello Retail. Each synonym expands a search query: when a visitor searches for word, results matching synonym are also included.

Name	Type	Required	Description
`websiteUuid`	string	Yes	The UUID of the customer's website in Hello Retail. Use `getWebsiteInfo` to look up available websites, or find it in my.helloretail.com under Settings → Website Settings → Website Unique Id.

Example request

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "listSearchSynonyms",
    "arguments": {
      "websiteUuid": "<string>"
    }
  }
}

Returns

[
  {
    "word": "<string>",
    "synonym": "<string>"
  }
]