On this page
MCP
Cloud MCP server that exposes the same workspace operations as Public REST. MCP only calls the Public API with the user’s API key — it does not hold Gmail/Maps provider secrets.
Host: https://mcp.notiq.io
Canonical docs: https://docs.notiq.io. White-label vanity MCP must not advertise NotiQ docs.
Auth (resolution order)
MCP accepts any of:
X-API-Key: sk_live_…Authorization: Bearer sk_live_…Authorization: Bearer mcp_at_…— OAuth access token from the consent flow
| Client | Typical method |
|---|---|
| Cursor | X-API-Key in MCP client headers |
| Claude / ChatGPT | OAuth — paste sk_… on the consent page (see Connect Claude / ChatGPT) |
Rules:
- Discovery /
initialize/tools/listmay omit a key;tools/callrequires one. - Outbound REST always uses
X-API-Keyonly (never Bearer, nevermcp_at_). - Never ask the user to paste a key into chat.
Tools ↔ REST (1:1)
| MCP tool | REST |
|---|---|
get_credits | GET /credits |
list_accounts | GET /accounts |
list_campaigns | GET /campaigns |
create_campaign | POST /campaigns |
get_campaign | GET /campaigns/:id |
start_campaign | POST /campaigns/:id/start |
pause_campaign | POST /campaigns/:id/pause |
list_leads | GET /campaigns/:id/leads |
get_lead | GET /campaigns/:id/leads/:leadId |
add_lead | POST /campaigns/:id/leads |
update_lead | PATCH /campaigns/:id/leads/:leadId |
send_message | POST /inbox/messages |
Argument schemas live on MCP tools/list after connect.
Credits & safety (for agents)
- Only
add_leadcosts 1 credit at call time. - Maps
create_campaigndiscovery debits 1 credit per email lead found asynchronously. - Confirm with the user before
send_messageorstart_campaign(real Gmail, irreversible). - Start with
list_accountsandlist_campaignsfor ids; paginate withnextCursor.
Discovery endpoints (no auth)
| Path | Role |
|---|---|
/health | Liveness + whether Public API base is configured |
/, /.well-known/mcp.json | Slim discovery JSON (tool names + blurbs) |
/.well-known/oauth-authorization-server | OAuth AS metadata |
/.well-known/oauth-protected-resource | OAuth resource metadata |
/llms.txt | Short machine-readable summary |
/mcp | Streamable HTTP MCP endpoint |
/authorize, /token, /register | OAuth / DCR (Claude/ChatGPT style clients) |
Connection tip (Cursor)
{
"mcpServers": {
"notiq": {
"url": "https://mcp.notiq.io/mcp",
"headers": {
"X-API-Key": "sk_live_…"
}
}
}
}
Create the key at /api-mcp.