Skip to main content
The OpenCX MCP server lets you manage your customer support platform directly from AI tools like Claude Desktop, Cursor, and VS Code. Your AI assistant can create contacts, manage chat sessions, train your AI agent, and more — all through natural language.

​
Quick Start

1

Get your API key

Go to your OpenCX Dashboard and navigate to Settings > API Keys > Create API Key. Copy the generated key.
2

Add to your AI tool

Add the following configuration to your AI tool’s MCP settings.
{
  "mcpServers": {
    "opencx": {
      "command": "npx",
      "args": ["-y", "@opencx/mcp"],
      "env": {
        "OPENCX_API_KEY": "your-api-key-here"
      }
    }
  }
}
3

Start using it

Ask your AI assistant something like:
  • “List my recent chat sessions”
  • “Create a new contact with email [email protected]”
  • “Show me customer insights from this week”
  • “Start a crawl on my documentation website”

​
Available Tools

The MCP server exposes the following tools organized by domain:

​
Contacts

ToolDescription
list_contactsList contacts with cursor pagination
create_contactCreate a new contact (email, phone, name, custom data)
update_contactUpdate contact fields
delete_contactDelete a contact by ID

​
Chat Sessions

ToolDescription
list_sessionsList sessions with filters (status, channel, date range)
get_sessionGet session details by ID
create_sessionCreate a new chat session for a contact
update_sessionUpdate session status (resolve, close, reopen)
send_messageSend a message in a session (as contact or agent)
get_session_historyGet message history for a session

​
AI Training

ToolDescription
list_training_scenariosList all custom training scenarios
create_training_scenarioCreate a new training scenario
update_training_scenarioUpdate an existing scenario
delete_training_scenarioDelete a scenario

​
Website Crawling

ToolDescription
list_datasourcesList website datasources
create_datasourceCreate a new website datasource to crawl
get_datasourceGet datasource details
start_crawlTrigger a crawl for a datasource
get_crawl_statusGet status of a crawl job
list_crawled_pagesList pages from a crawl

​
Customer Insights

ToolDescription
list_insightsList customer insights with pagination
get_insightGet a specific insight
resolve_insightMark an insight as resolved
assign_insightAssign an insight to a team
list_insight_categoriesList insight categories

​
Teams

ToolDescription
list_teamsList all teams
get_teamGet team details
create_teamCreate a new team
update_teamUpdate a team
delete_teamDelete a team
list_team_membersList users in a team
add_team_memberAdd a user to a team
remove_team_memberRemove a user from a team

​
Email

ToolDescription
send_emailSend AI-generated emails to contacts
list_email_domainsList configured email domains
add_email_domainAdd a custom sending domain
verify_email_domainVerify a domain’s DNS records

​
AI Phone Agents

ToolDescription
list_phone_agentsList AI phone agents
get_phone_agentGet phone agent details
create_phone_agentCreate a new AI phone agent
update_phone_agentUpdate phone agent config
delete_phone_agentDelete a phone agent
make_outbound_callTrigger an outbound AI call

​
Outbound Sequences

ToolDescription
create_sequenceCreate an outbound sequence
get_sequenceGet sequence details
update_sequenceUpdate a sequence
start_sequenceStart a sequence
cancel_sequenceCancel a running sequence
add_contacts_to_sequenceEnroll contacts in a sequence

​
Organization

ToolDescription
get_organizationGet organization info
update_organizationUpdate organization name

​
CSAT

ToolDescription
list_csat_scoresList customer satisfaction scores
get_csat_scoreGet a specific CSAT score
get_session_csatGet CSAT score for a session

​
Handoff Analytics

ToolDescription
get_handoff_analyticsGet AI-to-human handoff analytics (reasons, sentiment, trends)

​
WhatsApp

ToolDescription
send_whatsapp_templateSend a WhatsApp template message

​
Configuration

Environment VariableRequiredDefaultDescription
OPENCX_API_KEYYes—Your OpenCX API key
OPENCX_BASE_URLNohttps://api.open.cxAPI base URL (for self-hosted instances)

​
Requirements

  • Node.js 18 or later
  • An OpenCX account with an API key