> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omni.co/llms.txt
> Use this file to discover all available pages before exploring further.

# MCP server tools

> Unlock new ways to analyze & explore your data by connecting external AI tools to your Omni model with Omni's MCP server.

export const XCircleIcon = ({label}) => {
  return <span>
      <Icon icon="circle-xmark" iconType="solid" color="#ff2465" />
      {label && ` ${label}`}
    </span>;
};

export const CheckIcon = ({label}) => {
  return <span>
      <Icon icon="circle-check" iconType="solid" color="#26bd6c" />
      {label && ` ${label}`}
    </span>;
};

The MCP server includes tools for querying Omni data and searching the official Omni docs for product and *"How do I..."*-type questions.

## Tool availability

To use any of the MCP server tools, the top-level **MCP server** setting in [**AI Hub > MCP**](/ai/settings/mcp) must be enabled. This setting is enabled by default.

Organization Admins can also individually enable or disable tool capabilities in the MCP settings page.

If certain tools are not available in your MCP client, check with an Organization Admin to confirm which capabilities are enabled for your organization.

## Querying

The MCP server uses the tools in this section to process the queries it receives.

<h3 id="pick-model">
  pickModel
</h3>

Returns a list of available models and their IDs, which the MCP client uses to select which model to query. You can also provide a model ID in the MCP configuration to skip this step.

This tool is available if the [Agentic capabilities](/ai/settings/mcp#agentic) or [Single shot query generation setting](/ai/settings/mcp#single-shot) is enabled.

<h3 id="pick-topic">
  pickTopic
</h3>

Returns available topics in the model selected by [`pickModel`](#pick-model) and selects the most relevant topic for the query.

If the AI is allowed to query any view in the model (enabled with the `X-MCP-Query-All-Views` header during setup), this step becomes optional: the AI can query any view in the model directly, not just topics.

This tool is available if the [Agentic capabilities](/ai/settings/mcp#agentic) or [Single shot query generation setting](/ai/settings/mcp#single-shot) is enabled.

<h3 id="get-data">
  getData
</h3>

<Note>
  The [Single shot query generation setting](/ai/settings/mcp#single-shot) must be enabled to use this tool.
</Note>

Executes the query against the selected model and topic (or view, if the AI can query outside of topics) and returns the results.

## Advanced agentic queries

<Note>
  The [Agentic capabilities setting](/ai/settings/mcp#agentic) must be enabled to use the tools in this section.
</Note>

For complex, multi-step questions that require deeper analysis beyond what a single query can provide, the MCP server includes two additional tools that expose Omni's full agentic AI assistant: `askOmni` and `checkStatus`. Using these tools together prevents timeout issues that could occur if waiting for long-running agentic jobs to complete in a single request.

<h3 id="ask-omni">
  askOmni
</h3>

Submits an agentic analysis job to Omni and returns immediately without waiting for completion. Designed for open-ended questions that may require multiple steps, data exploration, or iterative analysis.

<h3 id="check-status">
  checkStatus
</h3>

Polls the status of a previously submitted job using its `jobId`.

<h2 id="search-omni-docs">
  Search Omni documentation (searchOmniDocs)
</h2>

<Note>
  The [Omni documentation search setting](/ai/settings/mcp#doc-search) must be enabled to use this tool.
</Note>

In addition to data querying tools, the MCP server includes a `searchOmniDocs` tool that provides AI-powered search of Omni's documentation.

When you ask questions about how to use Omni, the MCP client can automatically use this tool to:

* Search Omni's documentation for relevant information
* Synthesize answers from multiple documentation sources
* Provide citations to specific documentation pages

For example, you could ask *"How do I create a calculated field in Omni?"* and the `searchOmniDocs` tool will search the documentation, analyze the relevant pages, and return a comprehensive answer with links to the source documentation.

The tool uses the same AI-powered search pipeline as the Omni Agent, ensuring accurate and contextually relevant responses.

## Tool and setting comparison

The following table shows what MCP tools are available if a specific [MCP setting](/ai/settings/mcp) is enabled.

| MCP tool                            | Agentic capabilities | Omni documentation search | Single shot query generation |
| ----------------------------------- | -------------------- | ------------------------- | ---------------------------- |
| [pickModel](#pick-model)            | <CheckIcon /> yes    | <XCircleIcon /> no        | <CheckIcon /> yes            |
| [pickTopic](#pick-topic)            | <CheckIcon /> yes    | <XCircleIcon /> no        | <CheckIcon /> yes            |
| [getData](#get-data)                | <XCircleIcon /> no   | <XCircleIcon /> no        | <CheckIcon /> yes            |
| [askOmni](#ask-omni)                | <CheckIcon /> yes    | <XCircleIcon /> no        | <XCircleIcon /> no           |
| [checkStatus](#check-status)        | <CheckIcon /> yes    | <XCircleIcon /> no        | <XCircleIcon />  no          |
| [searchOmniDocs](#search-omni-docs) | <XCircleIcon /> no   | <CheckIcon /> no          | <XCircleIcon /> no           |

## Related

* [AI MCP settings](/ai/settings/mcp) - Enable and disable MCP server tool capabilities
* [AI feature settings](/ai/settings/features) - Enable and disable individual AI features in your Omni organization
* [AI Hub](/administration/ai-hub) - Monitor how your organization uses Omni AI