Use this file to discover all available pages before exploring further.
Claude Code is the command line version of Anthropic’s AI assistant, Claude. Once successfully connected to Omni, you can interact with your Omni data right in your Claude Code session.Looking for the Omni agent skills for Claude Code? See the Agent skills documentation for a broader set of skills beyond querying.Looking for Claude Desktop? Check out the Claude Desktop guide.
The official Omni connector for Claude provides the fastest setup experience with no manual configuration required.
1
Install the connector
Visit the Omni Analytics connector page and click Add to Claude to install the connector. This adds the Omni MCP server to both Claude Desktop and Claude Code.
2
Start a new Claude Code session
Run claude to start a new session. The Omni MCP server will be available automatically.
3
Authorize the connection
Claude Code will detect the Omni connector and prompt you to authenticate.
Your browser will open and redirect you to an Omni authorization page.
Review the requested permissions and click Authorize.
Omni will automatically create a Personal access token and link it to your Omni user account.
4
Verify the connection
At this point, you should be able to use the Omni MCP server in your Claude Code sessions:
You can also add the Omni MCP server manually via the Claude Code CLI.
1
Add the Omni MCP server
In your terminal, run the following command:
claude mcp add --transport http omni https://callbacks.omniapp.co/callback/mcp
2
Start a new Claude session
Run claude to start a new session.
3
Authenticate with Omni
Run /mcp to open the MCP servers list:
Navigate to and select the Omni MCP server:
Press Enter to select the Authenticate option.
Your browser will open and redirect you to an Omni authorization page.
Review the requested permissions and click Authorize.
Omni will automatically create a Personal access token and link it to your Omni user account.
4
Verify the connection
At this point, you should be able to use the Omni MCP server in your Claude Code sessions:
Claude Code Cloud runs agents on your repositories in the cloud. MCP servers are configured by committing a .mcp.json file to the root of any repository where you want Omni available.
You’ll need an Omni API key for this setup. See API authentication if you need to create one.
1
Create the .mcp.json file
In the root of your repository, create a file named .mcp.json:
<OPTIONAL_OMNI_MODEL_ID> - Optional. Scope the MCP to a specific model
<OPTIONAL_TOPIC_NAME> - Optional. Scope the MCP to a specific topic
<true/false> - Optional. Require a User ID to execute queries with that user’s permissions (default: false)
<USER_ID> - Optional. Execute queries as this user. Get IDs from the List Users API
2
Commit the file
Commit .mcp.json to your repository. When you start a new Claude Code Cloud session on that repository, the MCP server will be loaded automatically.To keep credentials out of version control, reference environment variables using ${VAR} syntax instead of hardcoding values:
If you used ${VAR} references in your .mcp.json, add the corresponding values to your Cloud Environment variables (e.g., OMNI_API_KEY=key). These are injected at runtime and never stored in your repository.
4
Start a new session
Start a new Claude Code Cloud session from claude.ai/code or the Claude desktop app. When prompted, select the GitHub repository where you committed .mcp.json. Claude Code Cloud will detect the file and load the Omni MCP server automatically.
