Skip to main content
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 the MCP server tools, the following settings must be enabled:
  • The top-level MCP server setting in AI Hub > MCP. Enabled by default.
  • The Enable AI and Omni Agent settings in AI Hub > Features. The MCP querying and docs search tools use the same AI pipeline as the Omni Agent, so disabling Omni Agent disables every MCP tool except pickModel. The tools will still appear in your MCP client, but calls will return 403 Feature is not enabled errors.
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.

​
pickModel

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 or Single shot query generation setting is enabled.

​
pickTopic

Returns available topics in the model selected by pickModel 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 or Single shot query generation setting is enabled.

​
getData

The Single shot query generation setting must be enabled to use this tool.
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

The Agentic capabilities setting must be enabled to use the tools in this section.
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.

​
askOmni

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. Because askOmni runs the full agent, it can also create routines — ask for something recurring (“every Monday at 9am, email me a summary of last week’s signups”) and the agent sets up a scheduled prompt that runs with your permissions and delivers by email or Slack. To view, edit, pause, or delete routines, use the Routines page, API, or Omni CLI.

​
checkStatus

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

​
Search Omni documentation (searchOmniDocs)

The Omni documentation search setting must be enabled to use this tool.
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.

​
Search dashboards (searchDashboards)

The Content access setting must be enabled to use this tool.
The searchDashboards tool lets MCP clients find existing dashboards in your Omni organization by name, folder, or tile name. This helps prevent generating new queries for data that already exists in a saved dashboard. When enabled, the MCP client can search your organization’s saved content and return matching dashboards instead of creating a query from scratch.
Unlike other MCP tools, searchDashboards does not honor the X-MCP-User-ID impersonation header. When using an Organization API key, search results reflect the API key owner’s permissions rather than the impersonated user’s permissions.

​
List dashboard queries (listDashboardQueries)

The Content access setting must be enabled to use this tool.
Given a dashboard identifier, the listDashboardQueries tool lists that dashboard’s tiles (saved queries) with each tile’s id, name, and queryIdentifierMapKey. This tool pairs with searchDashboards — search finds the dashboard, then this shows what’s on it.
Like searchDashboards, the listDashboardQueries tool does not honor the X-MCP-User-ID impersonation header. When using an Organization API key, results reflect the API key owner’s permissions rather than the impersonated user’s permissions.

​
Tool and setting comparison

The following table shows what MCP tools are available if a specific MCP setting is enabled.
  • AI MCP settings - Enable and disable MCP server tool capabilities
  • AI feature settings - Enable and disable individual AI features in your Omni organization
  • AI Hub - Monitor how your organization uses Omni AI