Skip to main content
Visual Studio Code (VS Code) is a code editor that, when paired with GitHub Copilot, empowers development with AI-backed features. VS Code can connect with other tools - like Omni! - using MCP. Once successfully connected, you can interact with your Omni data right in VS Code’s interface.

​
Requirements

Every person who wants to use the MCP Server must complete the setup. To do this, you’ll need:

​
Setup

1

Add the MCP Server

  1. In VS Code, open the Command Palette (Mac - ⌘ + Shift + P, Windows - Ctrl + Shift + P).
  2. Search for MCP and select MCP: Add Server.
  3. Select HTTP (HTTP or Server-Sent events) for the MCP Server type and press Enter.
  4. Paste your Omni instance URL and append it with /mcp/https. For example: 
    https://blobsrus.omniapp.co/mcp/https
    Press Enter.
  5. Enter a name for the MCP Server, such as Omni MCP. Press Enter.
  6. Select Workplace Settings and press Enter.
2

Configure the MCP Server

A .vscode/mcp.json file should have been created in your project.
  1. Open the file. At this point, it should look something like this:
    Blank .vscode/mcp.json
    {
   "servers": {
      "Omni": {
         "url": "https://YOUR-OMNI-INSTANCE/mcp/https"
      }
   }
}
  2. Update your mcp.json file to include the inputs and headers objects:
    Example VS Code MCP configuration
    {
   "inputs": {
      "type": "promptString",
      "id": "omni-mcp-key",
      "description": "API key for Omni Data MCP",
      "password": true
   },
   "servers": {
      "Omni": {
         "url": "https://YOUR-OMNI-INSTANCE/mcp/https",
         "headers": {
         "Authorization": "Bearer <OMNI_API_KEY>",
         "X-MCP-Model-ID": "<OPTIONAL_OMNI_MODEL_ID>",
         "X-MCP-Topic-Name": "<OPTIONAL_TOPIC_NAME>",
         "X-MCP-User-Required": "<true/false>",
         "X-MCP-User-ID": "<OPTIONAL-OMNI-USER-ID>"
         }
      }
   }
}
  3. 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. This will be appended with /mcp/https, which tells VS Code what type of MCP Server is being used.
    • <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.omniapp.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.
  4. Save the file.
3

Start the MCP Server

Before you can use the server, you’ll need to start it:
  1. Open the Command Palette again (Mac - ⌘ + Shift + P, Windows - Ctrl + Shift + P).
  2. Search for MCP and select MCP: List Servers.
  3. The Omni server should display in the list of servers. Click the server.
  4. A list of commands will display. Click Start Server.
You should see logs related to the Omni server begin to stream into the Terminal panel. Logs similar to the following example indicate that the server started successfully:
[info] Starting server Omni
[info] Connection state: Starting
[info] Starting server from LocalProcess extension host
[info] Connection state: Running
[info] Discovered 2 tools

​
VS Code Copilot + MCP

Once the MCP Server is available, VS Code will automatically be able to use it in chat when it receives a relevant prompt. You can prompt VS Code to use Omni by referring to it by name or description.
  1. Open the chat panel (Mac - ⌃ + ⌘ + I, Windows - Ctrl + Alt + P).
  2. Select Agent mode.
  3. Enter a prompt, such as Hey Omni, tell me how many users have been sourced by search and email and submit it to the chat.
  4. By default, when a tool is invoked, you need to confirm the action before VS Code will run it. Click Continue to proceed.
  5. The MCP Server will pick a model (if not configured) and topic, and then run a query to retrieve the data.