MCP Integration Guide

This guide explains how to integrate OX Security with your IDE using an MCP server. It includes setup for the following:

• MCP Integration key

• Cursor integration with OX MCP

• Claude Desktop integration with OX MCP

• VS Code integration with OX MCP

Creating a new MCP integration key

To integrate with the MCP server, you need to create an integration key.

To create a new MCP integration key:

1. From the left pane of the OX dashboard, select Settings > API Key Settings.

2. In the API Key Settings window, select CREATE API KEY.

1. In the Create API Key box set the following:

Parameter	Description
API Key Name	A descriptive name for the API key to identify its purpose MCP key 1
API Key Type	Select MCP Integration
Assign role	Assign a role according to your permissions needs. Example: Admin for full access. Operator for limited access to specific actions.
Assign scopes	Defines which applications and issues the API key can access: Entire organization: Access to all applications and issues in the organization. Custom: Access restricted to specific applications/issues.
Expiration Date	The date and time when the API key will expire and no longer be valid.

1. Copy the API Key Secret to be used when connecting to APIs. Save the key in a safe location. This is the only time when you can see and copy the actual key.

2. Select CLOSE. The new key appears in the API Key Settings page.

Integrating Cursor with OX MCP

By integrating with OX’s MCP, Cursor becomes a security-aware development assistant, able to query live security data, suggest actions, and triage issues directly from your IDE

To integrate Cursor with OX MCP:

1. Click here, to open Cursor in the relevant location where you can start working.

1. In the authorization header, replace the placeholder value with the MCP Integration key that you saved.

2. Click Install.

In the Cursor tools menu, OX Security logo appears.

More info: Cursor Documentation.

Integrating Claude Desktop with OX MCP

Claude Desktop offers an intuitive interface for integrating with OX Security's MCP, providing teams with robust security capabilities directly from their desktop environment.

Note: Ensure Node.js v18+ is installed. If using nvm, make sure no versions lower than 18.x are active.

To integrate Claude Desktop with OX MCP:

1. In Claude Desktop, go to Settings > Developer.

1. Select Edit Config.

Claude automatically opens the configuration file claude_desktop_config.json

1. Add the JSON MCP server configuration for OX Security as provided by your administrator or documentation.

{
  "mcpServers": {
    "ox-security": {
      "command": "npx",
      "args": [
        "-y",
        "[email protected]",
        "https://api.cloud.ox.security/api/mcp",
        "--header",
        "Authorization:${AUTH_TOKEN}"
      ],
      "timeout": 60000,
      "initTimeout": 30000,
      "env": {
        "AUTH_TOKEN": "PASTE_YOUR_API_TOKEN_HERE"
      }
    }
  }
}

1. Replace PASTE_YOUR_API_TOKEN_HERE with the MCP Integration key that you saved.

2. Save the file and restart Claude Desktop.

After restart, OX Security appears as an available MCP server in Claude Desktop.

Troubleshooting (Windows)

In case you have issues setting up MCP servers in Windows, consider using alternative commands, such as npx.cmd or direct Node.js execution.

Use npx.cmd:

{
  "mcpServers": {
    "ox-security": {
      "command": "npx.cmd",
      "args": [
        "-y",
        "[email protected]",
        "https://api.cloud.ox.security/api/mcp",
        "--header",
        "Authorization:${AUTH_TOKEN}"
      ],
      "env": {
        "AUTH_TOKEN": "PASTE_YOUR_API_TOKEN_HERE"
      }
    }
  }
}

Run Node.js directly:

1. Install MCP Remote globally:

   npm install -g [email protected]

2. Update your config with your local Node.js path:

{
  "mcpServers": {
    "ox-security": {
      "command": "C:\YOUR_NODE_INSTALL_FOLDER\node.exe",
      "args": [
        "YOUR_MCP_REMOTE_FOLDER\node_modules\mcp-remote\dist\client.js",
        "https://api.cloud.ox.security/api/mcp",
        "--header",
        "Authorization:${AUTH_TOKEN}"
      ],
      "env": {
        "AUTH_TOKEN": "PASTE_YOUR_API_TOKEN_HERE"
      }
    }
  }
}

Integrating Visual Code with OX MCP

Visual Studio Code provides versatile options to connect with OX Security's MCP, enabling developers to streamline their security workflows within the versatile VS Code ecosystem.

To integrate VS Code with OX MCP:

1. Open VS Code Settings.

2. Open MCP User Configuration, see VS Code MCP Docs for details.

1. Add the JSON MCP server configuration for OX Security in mcp.json:

{
  "servers": {
    "ox-security": {
      "type": "http",
      "url": "https://api.cloud.ox.security/api/mcp",
      "headers": {
        "Authorization": "PASTE_YOUR_API_TOKEN_HERE"
      }
    }
  }
}

1. Replace PASTE_YOUR_API_TOKEN_HERE with the MCP Integration key that you saved.

2. Save the configuration.

3. In the VS Code chat, click Add Context.

1. Select the desired tools.

OX Security appears as an available MCP server.