Skip to main content
Claude Desktop is the app version of Anthropic’s AI assistant, Claude. Once successfully connected to Omni, you can interact with your Omni data right in the Claude Desktop interface.

​
Requirements

Every person who wants to use the MCP Server must complete the setup. To do this, you’ll need:
  • The following installed on your computer:
    • The latest version of Claude Desktop
    • npm and Node.js. Omni uses the omni-co/mcp package to automate MCP Server setup for clients like Claude Desktop. To see if these are already installed, run the following from the command line: 
      node -v
npm -v
      Refer to the npm docs if you need help getting started with npm.
  • An Omni API key. Refer to the API documentation for more information.

​
Setup

  1. In Claude Desktop, navigate to Settings > Developer.
  2. Click Edit Config. If you haven’t previously added an MCP Server to Claude Desktop, clicking this button will create a claude_desktop_config.json file.
  3. Open this file and add the following to the mcpServers key:
    Example Claude Desktop MCP configuration
    {
   "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>"
         }
      }
   }
}
  4. You’ll need to make a few changes to complete the setup. In the mcp.json, fill in the following:
    • <YOUR_OMNI_INSTANCE> - Required. The URL of your Omni instance, for example: https://blobsrus.omniapp.co.
    • <OMNI_API_KEY> - Required. Your Omni API key.
    • <OPTIONAL_OMNI_MODEL_ID> - Optional. The ID of the model to scope the MCP Server to. If not provided, the MCP Server will use the pickModel tool to dynamically select a model. You can retrieve a model ID by opening the model in Omni’s model IDE and looking at the URL. The string between /models/ and /ide/ is the model ID: 
      https://blobsrus.omni.co/models/9d9440e5-8522-4507-b092-1ac26ba26673/ide/model?mode=combined
    • <OPTIONAL_TOPIC_NAME> - Optional. If provided, the MCP Server will be scoped only to this topic. Remove this parameter to allow dynamic topic switching.
    • <true/false> - Optional. If true, the MCP Server will require a User ID to execute queries with the permissions of the given user. Defaults to false.
    • <USER_ID> - Optional. If provided, the MCP Server will be scoped to this User ID. IDs can be pulled using the List Users API.
  5. Save the file.
  6. Restart Claude Desktop.
  7. Once Claude Desktop has restarted, confirm that the MCP Server is running by navigating back to Settings > Developers.
  8. Click the Omni MCP server to open its details. You should see a running badge next to the server name: Claude Desktop MCP Server status showing running badge

​
Claude Desktop chat + MCP

Once the MCP Server is available, Claude Desktop will automatically be able to use it in chat when it receives a relevant prompt. You can prompt Claude to use Omni by referring to it by name or description.
  1. Enter a prompt in the chat panel, such as Hey Omni, tell me how many users have been sourced by referrals, and submit it to the chat.
  2. Each time Claude uses an MCP tool, you’ll be prompted to approve its usage. Click Allow once or Allow always to proceed: Claude Desktop MCP approval prompt
  3. The MCP Server will begin by picking a model (if not configured) and topic, and then run a query to retrieve the data: Claude Desktop chat with MCP Server running a query