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.
Setup
Choose your authentication method. See the MCP authentication guide if you need help selecting a method.
OAuth (Recommended)
API Key
OAuth provides streamlined setup without manually managing API keys.Add the MCP Server
- Open the Command Palette (
⌘ + Shift + P on Mac, Ctrl + Shift + P on Windows).
- Search for
MCP and select MCP: Add Server.
- Select HTTP (HTTP or Server-Sent events) and press Enter.
- Paste the OAuth URL and press Enter:
https://callbacks.omniapp.co/callback/mcp
- Enter a name for the server (e.g.,
Omni MCP) and press Enter.
- Select Global or Workspace settings and press Enter.
Start the MCP Server
VS Code should open a file named mcp.json and automatically prompt you to authorize the connection:
If this doesn’t happen, complete the following:
-
Open the Command Palette again.
-
Search for
MCP and select MCP: List Servers.
-
Click the Omni server in the list.
-
Click Start Server or Restart above the server in the
mcp.json file:
-
When prompted, allow VS Code to open the browser.
Authorize the connection
- 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.Verify the connection
You should see logs in the Terminal panel indicating the server started:[info] Starting server Omni
[info] Connection state: Starting
[info] Starting server from LocalProcess extension host
[info] Connection state: Running
[info] Discovered 3 tools
API key authentication gives you direct control over key management.Create an API key
If you don’t have an Omni API key, create one before continuing. Add the MCP Server
- Open the Command Palette (
⌘ + Shift + P on Mac, Ctrl + Shift + P on Windows).
- Search for
MCP and select MCP: Add Server.
- Select HTTP (HTTP or Server-Sent events) and press Enter.
- Paste your Omni instance URL with
/mcp/https appended:
https://<YOUR_OMNI_INSTANCE>/mcp/https
- Enter a name for the server (e.g.,
Omni MCP) and press Enter.
- Select Workspace Settings and press Enter.
Configure the MCP Server
A .vscode/mcp.json file was created in your project. Open it and update it to include headers:{
"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>"
}
}
}
}
Replace 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
Save the file.Start the MCP Server
- Open the Command Palette again
- Search for
MCP and select MCP: List Servers
- Click the Omni server in the list
- Click Start Server
You should see logs in the Terminal panel indicating the server started:[info] Starting server Omni
[info] Connection state: Starting
[info] Starting server from LocalProcess extension host
[info] Connection state: Running
[info] Discovered 2 tools
Using the MCP
Once the MCP Server is connected, VS Code automatically uses it when you ask questions about your data. You can prompt VS Code to use Omni by referring to it by name or description.
Open the chat panel (⌃ + ⌘ + I on Mac, Ctrl + Alt + I on Windows).
Enter a prompt, such as Hey Omni, tell me how many users have been sourced by search and email.
By default, you need to confirm each tool invocation. Click Continue to proceed.
The MCP Server will pick a model (if not configured for API key authentication) and topic, then run a query to retrieve the data.
