Using the MCP Server in Claude Desktop

​

Requirements

• The latest version of Claude Desktop installed
• The MCP Server AI setting enabled in your Omni instance. An Organization Admin can enable this setting by navigating to AI Hub > MCP.
• For API key setup only: npm and Node.js installed. Check with:
  node -v
  npm -v
  

​

Setup

• Claude Connector (Recommended)
• Custom OAuth
• API Key

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.

2

Authorize the connection

1. Claude will redirect you to an Omni authorization page.
2. Review the requested permissions and click Authorize.

Omni will automatically create a Personal access token and link it to your Omni user account.

3

Verify the connection

At this point, you should be able to use the Omni MCP server in your Claude Desktop chats.In a chat, click the (plus) icon, then Connectors. Your Omni MCP connection should be enabled:

OAuth provides streamlined setup without manually managing API keys. Use this method if you need to configure the connector manually.

1

Open Claude Desktop settings

In Claude Desktop, navigate to Settings > Connectors.

2

Add a custom connector

Click Add custom connector.

3

Configure the connector

In the dialog that displays, fill in the following:

• Name - Enter a name for the connector, such as Omni
• Remote MCP Server URL - Paste the following URL:
  https://callbacks.omniapp.co/callback/mcp
  

Your configuration should look like this:Click Add to create the connector.

4

Authorize the connection

Claude Desktop will add the connector to the connector list.

1. Click the Connect button next to the Omni connector you just created.
2. Your browser will open and redirect you to an Omni authorization page.
3. Review the requested permissions and click Authorize.

Omni will automatically create a Personal access token and link it to your Omni user account.

5

Verify the connection

At this point, you should be able to use the Omni MCP server in your Claude Desktop chats.In a chat, click the (plus) icon, then Connectors. Your Omni MCP connection should be enabled:

API key authentication gives you direct control over key management.

1

Create an API key

If you don’t have an Omni API key, create one before continuing.

2

Open Claude Desktop settings

In Claude Desktop, navigate to Settings > Developer.

3

Edit the config file

Click Edit Config. This opens (or creates) claude_desktop_config.json.

4

Add the MCP server

Add the following to the mcpServers key:

claude_desktop_config.json

{
  "mcpServers": {
    "Omni MCP": {
      "command": "npx",
      "args": ["@omni-co/mcp"],
      "env": {
        "DEBUG": "true",
        "MCP_SERVER_URL": "https://<YOUR_OMNI_INSTANCE>/mcp/https",
        "MCP_API_KEY": "<OMNI_API_KEY>",
        "MCP_MODEL_ID": "<OPTIONAL_OMNI_MODEL_ID>",
        "MCP_TOPIC_NAME": "<OPTIONAL_TOPIC_NAME>",
        "MCP_USER_REQUIRED": "<true/false>",
        "MCP_USER_ID": "<USER_ID>",
        "MCP_QUERY_ALL_VIEWS": "<true/false>"
      }
    }
  }
}

5

Configure the server

Replace the placeholder values:

• <YOUR_OMNI_INSTANCE> - Required. Your Omni URL (e.g., acme.omniapp.co)
• <OMNI_API_KEY> - Required. Your Omni API key
• <OPTIONAL_OMNI_MODEL_ID> - Optional. Scope the MCP to a specific model. Find the model ID in the URL when viewing the model:
  https://acme.omniapp.co/models/9d9440e5-8522-4507-b092-1ac26ba26673/ide/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
• <true/false> for MCP_QUERY_ALL_VIEWS - Optional. Set to true to allow the AI to query any view in the model instead of only topics. Requires the model’s query_all_views_and_fields setting to be enabled. Defaults to false.

6

Restart Claude Desktop

Save the file and restart Claude Desktop.

7

Verify the connection

Navigate to Settings > Developer and click Omni MCP. You should see a running badge:

​

Using the MCP

1. Enter a prompt in the chat panel, such as Hey Omni, tell me how many users have been sourced by referrals.
2. Each time Claude uses an MCP tool, you’ll be prompted to approve its usage. Click Allow once or Allow always to proceed:
3. The MCP Server will pick a model (if not configured) and topic, then run a query to retrieve the data: