Mcp get started - Open.cx Docs

Add the OpenCX server to your AI client so it can manage contacts, sessions, training, and more through natural language.

Prefer zero install? Connect to the hosted endpoint at https://api.open.cx/mcp — see Remote server below. The local npx setup only requires Node.js 18+.

Prerequisites: an OpenCX API key (created below). Node.js 18+ for the local npx setup.

Create an API key

Open your OpenCX dashboard and navigate to Settings > API Keys > Create API Key. Give it a descriptive name (e.g. “Cursor MCP”) and copy the key immediately — it is only shown once.

Add to your AI client

Paste the configuration below into your client’s MCP settings. Replace your-api-key-here with the key you just copied.

{
  "mcpServers": {
    "opencx": {
      "command": "npx",
      "args": ["-y", "@opencx/mcp"],
      "env": {
        "OPENCX_API_KEY": "your-api-key-here"
      }
    }
  }
}

{
  "mcpServers": {
    "opencx": {
      "command": "npx",
      "args": ["-y", "@opencx/mcp"],
      "env": {
        "OPENCX_API_KEY": "your-api-key-here"
      }
    }
  }
}

{
  "servers": {
    "opencx": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@opencx/mcp"],
      "env": {
        "OPENCX_API_KEY": "your-api-key-here"
      }
    }
  }
}

{
  "mcpServers": {
    "opencx": {
      "command": "npx",
      "args": ["-y", "@opencx/mcp"],
      "env": {
        "OPENCX_API_KEY": "your-api-key-here"
      }
    }
  }
}

export OPENCX_API_KEY="your-api-key-here"
claude mcp add opencx -- npx -y @opencx/mcp

Each client has its own config file and UI. See Cursor, Claude Desktop, Claude Code, VS Code, Windsurf, and Zed.

Verify the connection

Ask your AI assistant one of these prompts to confirm the server is connected:

“List my recent chat sessions”
“Show me CSAT scores from the last week”
“Search my knowledge base for refund policy”

If you get results back, the connection is working.

Remote server (no install)

OpenCX also hosts the MCP server over at https://api.open.cx/mcp. Nothing to install or keep updated — authenticate with the same API key as a bearer token:

claude mcp add --transport http opencx https://api.open.cx/mcp \
  --header "Authorization: Bearer your-api-key-here"

{
  "mcpServers": {
    "opencx": {
      "type": "http",
      "url": "https://api.open.cx/mcp",
      "headers": {
        "Authorization": "Bearer your-api-key-here"
      }
    }
  }
}

{
  "servers": {
    "opencx": {
      "type": "http",
      "url": "https://api.open.cx/mcp",
      "headers": {
        "Authorization": "Bearer your-api-key-here"
      }
    }
  }
}

The remote and local servers expose the same tools; pick whichever fits your environment. Self-hosted deployments serve the same endpoint at https://your-instance/mcp.

Authentication

The MCP server authenticates with a per-organization API key passed through the OPENCX_API_KEY environment variable.

Variable	Required	Default	Description
`OPENCX_API_KEY`	Yes	—	Your OpenCX API key
`OPENCX_BASE_URL`	No	`https://api.open.cx`	API base URL for self-hosted deployments

Rotating keys: Create a new key in Settings > API Keys, update your MCP client config, then delete the old key from the dashboard.

Never commit API keys to version control. Use your local MCP client config file or CI secrets for automated environments.

Self-hosted instances

If you run a self-hosted OpenCX deployment, set OPENCX_BASE_URL to your instance URL. The server requires HTTPS unless targeting localhost for local development.

Prompt Library

Ready-to-use prompts by domain

Cursor

Project config, agent mode, debugging

VS Code

mcp.json and Copilot

Troubleshooting

Debug connection and authentication issues

​Remote server (no install)

​Authentication

​Self-hosted instances

​Related Documentation

Prompt Library

Cursor

VS Code

Troubleshooting

Remote server (no install)

Authentication

Self-hosted instances

Related Documentation