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.

​
runQuery

The Single shot query generation setting must be enabled to use this tool.
Accepts a JSON query definition and executes it directly against the Run query API, without requiring the AI to construct a query from a model and topic selection. Use this tool when the query JSON is already known — for example, you paste a query definition or the query definition was produced earlier in the conversation. When using this tool, note that:
  • Results default to a limit of 500 rows and cap at 10,000
  • Keys such as userEditedSQL that would cause the query to run raw SQL against the connection will be refused
  • If a model is provided with the X-MCP-Topic-Name header during setup and query.modelId is also provided, they must match or the request will fail

​
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. When a branchId is provided, the agentic job runs its queries against that model branch and any model edits the agent makes are saved to that branch rather than creating a new one. This tool can also:
  • Create and edit dashboards. - When you ask the agent to edit an existing dashboard, the changes land in a draft. The changes won’t be live until you review and manually publish the changes. Brand new dashboards created by the agent are published immediately.
  • 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.

​
listBranches

Lists existing branches of a given base model. Use this tool alongside askOmni’s branchId parameter to target an existing branch instead of creating a new one. This tool does not honor the X-MCP-User-ID impersonation header. When using an Organization API key, the results reflect the API key owner’s permissions rather than the impersonated user’s permissions.

​
Content access

The Content access setting must be enabled to use the tools in this section.
Allows the MCP server to search your organization’s saved content, like dashboards, see the queries a dashboard contains, and run them.

​
searchDashboards

Searches your Omni organization for existing dashboards that match a provided name, folder, or tile name. This helps prevent generating new queries for data that already exists in a saved dashboard. Search results are scoped using the calling user’s API key or the X-MCP-User-ID impersonation header (if provided), ensuring that results reflect what the user can access according to their content and model permissions.

​
listDashboardQueries

Lists a dashboard’s tiles (saved queries). This tool is designed to pair with searchDashboards — search finds the dashboard, this tool shows what it contains. This tool does not honor the X-MCP-User-ID impersonation header. When using an Organization API key, the results reflect the API key owner’s permissions rather than the impersonated user’s permissions.

​
runSavedQuery

Executes a saved dashboard tile’s query by ID and returns the current results as JSON. This tool is designed for pulling consistent, model-aware data from a known tile rather than generating a new query. If an invalid or inaccessible queryId is provided, the tool returns an error without listing tile names to prevent information disclosure beyond impersonation scope. Use listDashboardQueries to retrieve valid query IDs for a dashboard. Query results are scoped using the calling user’s API key or the X-MCP-User-ID impersonation header (if provided), ensuring that data access safeguards such as row-level security (RLS) and access grants are respected.

​
Search Omni docs (searchOmniDocs)

The Omni documentation search setting must be enabled to use this tool.
Searches the Omni documentation and synthesizes answers in response to prompts that ask questions about how to use Omni. Responses include citations to documentation pages used to construct the answer to the prompt. This tool uses the same AI-powered search pipeline as the Omni Agent, ensuring accurate and contextually relevant responses. 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.

​
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