Skip to main content
Every action available through the REST API is also available as an MCP (Model Context Protocol) tool, so an AI client — Claude, Cursor, Codex — can manage your account directly. Ask it to “create an agent that qualifies leads, books a demo call, and hands off to sales” and it calls the same tools described below.

​
Getting a key

MCP keys are separate from your REST X-API-Key (see Authentication) and carry their own scopes.
  1. Open Integrations from your profile menu.
  2. Go to MCP Server.
  3. Create a key and pick the scopes it needs — least privilege by default. A read-only key can be handed to an agent you don’t fully trust yet.

​
Connecting a client

Server URL: https://mcp.getnexor.ai/mcp Claude Code 
claude mcp add --transport http nexor https://mcp.getnexor.ai/mcp --header "X-API-Key: YOUR_MCP_KEY"
Cursor / Claude Desktop (~/.cursor/mcp.json or Claude’s connector settings) 
{
  "mcpServers": {
    "nexor": {
      "url": "https://mcp.getnexor.ai/mcp",
      "headers": { "X-API-Key": "YOUR_MCP_KEY" }
    }
  }
}
Codex (~/.codex/config.toml) 
[mcp_servers.nexor]
command = "npx"
args = ["-y", "mcp-remote", "https://mcp.getnexor.ai/mcp", "--header", "X-API-Key: YOUR_MCP_KEY"]

​
Scopes

A key can only call tools within its granted scopes.
ScopeGrants
workflows:readView agents, their structure, custom tools, and background jobs
workflows:writeCreate and edit agents, prompts, structure, custom tools, and background jobs
leads:readView leads, history, and WhatsApp templates
leads:writeCreate/update leads, tags, status, and automation state
rules:readView reminder, recontact, and status-timeout rules
rules:writeCreate/update those rules
people:readView team members and pending invitations
invites:writeInvite or revoke people
messages:sendSend a WhatsApp/email message or trigger a call
meetings:writeLog meetings, notes, and conversions

​
Tool catalog

​
Workflows (agents)

This is the full “create an agent that does A, then B, then C” toolset — it maps directly to the Workflows and Workflow Tools REST endpoints.
ToolScopeDescription
list_workflowsworkflows:readList the client’s agents
get_workflowworkflows:readFetch one agent with statuses/fields/tools
create_workflowworkflows:writeCreate an agent (funnel) with statuses
set_workflow_promptworkflows:writeReplace an agent’s base (global) prompt
set_workflow_activeworkflows:writeActivate (unpause) or pause an agent
update_workflowworkflows:writeRename an agent or change its description
set_channel_promptworkflows:writeSet a per-channel prompt override (merged)
get_workflow_prompt_historyworkflows:readRead an agent’s prompt version history
update_workflow_structureworkflows:writeAdd/edit funnel statuses + fields (upsert, no delete)

​
Custom tools

ToolScopeDescription
list_workflow_toolsworkflows:readList an agent’s custom HTTP tools
create_workflow_toolworkflows:writeAdd a custom HTTP tool the agent can call
update_workflow_toolworkflows:writeEdit a custom tool’s config
delete_workflow_toolworkflows:writeRemove a custom tool (soft/hard)
set_tool_stage_gateworkflows:writeGate a custom tool to funnel stages

​
Background jobs

ToolScopeDescription
list_background_jobsworkflows:readList background jobs
get_background_jobworkflows:readGet a background job + recent executions
create_background_jobworkflows:writeCreate a scheduled/forced lead automation
update_background_jobworkflows:writeUpdate a background job config
delete_background_jobworkflows:writeDelete a background job
run_background_jobworkflows:writeForce-run a background job now
list_background_job_executionsworkflows:readA job’s execution history

​
Leads

ToolScopeDescription
list_leadsleads:readPage through leads with search/filter
get_leadleads:readOne lead with fields + engagement
get_lead_historyleads:readUnified lead timeline
upsert_leadsleads:writeCreate/update leads (idempotent), optional enroll
update_leadleads:writeUpdate lead fields/metadata
sync_lead_tagsleads:writeSet the exact tag set for a lead
assign_lead_to_workflowleads:writeMove a lead into an agent, start cadence
set_lead_statusleads:writeForce a lead’s funnel status (forward/back)
stop_automationleads:writeHuman takeover on: pause cadence
resume_automationleads:writeHuman takeover off; optionally resume cadence
delete_leadleads:writeSoft-delete (archive) a lead

​
Rules

ToolScopeDescription
list_reminder_rulesrules:readList lead reminder rules
set_reminder_rulerules:writeCreate/update a lead reminder rule
list_host_reminder_rulesrules:readList host notification rules
set_host_reminder_rulerules:writeCreate/update a host rule (email only)
list_recontact_rulesrules:readList re-engage rules
set_recontact_rulerules:writeCreate/update a re-engage rule
list_status_timeout_rulesrules:readList status auto-timeout configs
set_status_timeout_rulerules:writeSet/clear a status auto-timeout

​
People

ToolScopeDescription
list_teampeople:readList active team members
list_pending_invitationspeople:readList outstanding invitations
invite_userinvites:writeInvite a person (admin or human agent), idempotent
revoke_invitationinvites:writeCancel a pending invitation

​
Messaging

ToolScopeDescription
list_whatsapp_templatesleads:readList approved WhatsApp templates
send_messagemessages:sendSend WhatsApp/email or trigger a call

​
Account

ToolScopeDescription
list_lead_meetingsleads:readList a lead’s calendar events
create_meetingmeetings:writeLog a booked meeting (idempotent)
ingest_meeting_notesmeetings:writeAttach transcript/summary to a meeting
list_conversion_typesleads:readList active conversion types
set_conversion_typeleads:writeCreate or update a conversion type by name
create_conversionleads:writeRecord a conversion event
list_conversionsleads:readList conversion events
list_campaignsleads:readList campaigns

​
Meta

ToolScopeDescription
whoami—Authenticated client identity + granted scopes

​
Usage

Tool calls and error rates for the last 30 days are visible in the same Integrations → MCP Server page, per key.
Last modified on July 10, 2026