SearchUnify MCP Tools and Response Formats

This article documents the tools currently exposed by SearchUnify MCP, their supported parameters, and the standard response structure returned by the server.

SearchUnify MCP currently exposes the following tools:

  • search

  • get-filter-options

  • analytics

Use the search tool to run a SearchUnify query and retrieve relevant results.

Supported parameters

Parameter Required Description
searchString Yes

Query text to search for. Minimum 3 characters, maximum 100 characters
pageSize No

Number of results per page. Minimum 1, maximum 100
page No

Page number for pagination. Minimum 1, maximum 100
sortBy No

Sort field. Allowed values: _score, post_time
aggregations No

List of facet filters used to narrow results
versionResults No

Enables versioned document results. Default is false

Example aggregation format

Copy

JSON

{
  "type": "_type",
  "filter": "document"
}

Behavior notes

If the SearchUnify search client has GPT enabled, the tool returns enriched context with links and descriptions.

  • Otherwise, it returns standard search hits with title, summary, and URL.

  • HTML tags are stripped from results automatically.

  • When versionResults is supported in the search response, the primary document appears instead of separate versioned documents.

get-filter-options

Use the get-filter-options tool to discover available filters for a query before running a refined search.

Supported parameters

Parameter

 Required Description
searchString Yes

Query text to search for. Minimum 3 characters, maximum 100 characters
aggregations No

Existing filters, used when you want contextual filter options for an already filtered query

Response structure

This tool returns aggregation groups containing:

  • key

  • label

  • order

  • values

Each values entry may include fields such as:

  • displayName

  • value

  • contentName

Recommended usage pattern

A common flow is:

  • Call get-filter-options.

  • Review the available filters.

  • Pass the selected filters into search.

This is the recommended approach when you want the assistant to progressively narrow a search based on available SearchUnify facets.

analytics

Use the analytics tool to retrieve SearchUnify analytics reports.

Supported parameters

Parameter

 Required Description
reportType Yes

Type of analytics report
startDate Yes

Start date of the reporting period
endDate Yes

End date of the reporting period
count Yes

Number of records to fetch

Supported report types

  • searchQueryWithNoClicks

  • searchQueryWithResult

  • searchQueryWithoutResults

  • getAllSearchQuery

  • getAllSearchConversion

Standard response format

The response structure remains the same whether SearchUnifyGPT™ is active or not. Only the returned content changes.

Sample response

Copy

JSON

{
  "content": [
    {
      "type": "text",
      "text": "title: How to Configure Search Clients\nsummary: Learn how to set up and manage search clients in SearchUnify.\nurl: https://docs.searchunify.com/search-clients\n---\ntitle: Content Sources Overview\nsummary: A guide to adding and managing content sources.\nurl: https://docs.searchunify.com/content-sources\n---"
    }
  ]
}

Note

For integration help, API key access, or Search Client UID details, contact the SearchUnify technical support team.