MCP Server
Connect your AI tools to Novu using MCP and manage notifications using natural language.
The Novu MCP Server exposes Novu's notification infrastructure as tools that AI assistants can discover and use in real time.
Once connected, you can use natural language to manage notifications in Novu directly from your AI tool. For example, you can prompt your AI assistant to:
- Trigger workflows for specific subscribers
- Search and inspect subscriber data
- Update subscriber notification preferences
- Debug failed notifications and delivery issues
- Analyze notification activity and logs
- Create and manage workflows
How Novu MCP works
The Novu MCP Server exposes your notification system as a set of tools.
When your AI assistant connects:
- It authenticates using your API key.
- It discovers available tools.
- It executes actions based on your prompts.
Instead of calling APIs directly, the AI translates your request into tool calls and executes them against your Novu environment.
Prerequisite
To use the Novu MCP Server, you'll need:
- A Novu API key
- An MCP-compatible AI tool (Cursor, Codex, Claude Code, Claude Desktop)
Setup
Follow these steps to setup the Novu MCP server:
1. Get your secret key
Your secret key authenticates your AI tool with Novu. To retrieve it:
- Go to the Novu Dashboard
- Navigate to API Keys
- Under Secret Keys, copy your secret key
2. Identify your region
Your region determines which URL your AI tool connects to. To identify it, check your dashboard URL:
| Dashboard URL | Region | MCP URL |
|---|---|---|
dashboard.novu.co | US | https://mcp.novu.co/ |
eu.dashboard.novu.co | EU | https://mcp.novu.co/?region=eu |
The MCP URL above is what you'll use in the next step when configuring your tool.
3. Configure your tool
The following sections cover setup for the most common MCP-compatible AI tools. Before you start, keep two things in mind as you work through the examples:
- Replace the API key. Each example uses
your-novu-api-keyas a placeholder. Replace it with the API key you copied earlier. - Use the correct URL for your region. The examples use the US endpoint (
https://mcp.novu.co/). If you're on the EU region, replace it withhttps://mcp.novu.co/?region=eu.
Cursor
Cursor supports remote MCP servers through its built-in settings UI, which writes to an mcp.json file. To add the Novu MCP Server:
-
Open Cursor Settings, and select Tools & Integrations.
-
Under MCP Tools, select New MCP Server. This opens your
mcp.jsonfile. -
Add the following to the
mcpServersobject: -
Save the file. Cursor detects the new server automatically.
Codex
Codex reads MCP configuration from ~/.codex/config.toml. The CLI and IDE extension share this file, so you only need to configure the server once. To add the Novu MCP Server:
-
Export your API key as an environment variable in your shell:
-
Open
~/.codex/config.tomlin your preferred text editor and add the following: -
Save the file and restart Codex. To verify the connection, run
/mcpinside the Codex TUI. You should seenovulisted as a connected server.
Claude Code
Claude Code manages MCP servers through its claude mcp command. To add the Novu MCP Server:
-
In your terminal, run:
-
To make Novu available across all your projects instead of just the current one, add the
--scope userflag: -
Verify the connection by running
claude mcp list. You can also run/mcpinside Claude Code to check server status.
Claude Desktop
Claude Desktop connects to remote MCP servers through a local proxy (mcp-remote), which requires Node.js 18 or higher. To add the Novu MCP Server:
-
Open Claude Desktop, go to Settings, and find the Developer section.
-
Select Edit Config. This opens your
claude_desktop_config.jsonfile. -
Add the following to the
mcpServersobject (or create the object if it doesn't exist): -
Save the file and restart Claude Desktop.
Other tools
Any MCP-compatible tool can connect to the Novu MCP Server. Use the following connection details:
- URL:
- US:
https://mcp.novu.co/ - EU:
https://mcp.novu.co/?region=eu
- US:
- Transport: Streamable HTTP (recommended).
- Authentication: Send your API key in the
Authorizationheader asBearer your-novu-api-key.
Test your setup
To verify that the connection works, try any of the prompts below in your AI assistant:
If you get results back, the Novu MCP Server is connected and working.
Available tools
The Novu MCP server currently provides 23 tools for interacting with your Novu environment:
Core operations
These tools let you inspect your account configuration:
| Tool | Description |
|---|---|
get_api_key_status | Check API key status and region configuration |
get_environments | List development and production environments |
Subscriber management
These tools let you create, inspect, and manage your subscribers:
| Tool | Description |
|---|---|
create_subscriber | Create a new subscriber with attributes like name, email, phone, and custom data |
get_subscriber | Retrieve a single subscriber by their subscriberId |
update_subscriber | Update an existing subscriber's attributes |
delete_subscriber | Delete a subscriber by their subscriberId |
find_subscribers | Search for subscribers using various query parameters |
Preferences
These tools let you view and update how subscribers receive notifications:
| Tool | Description |
|---|---|
get_subscriber_preferences | Get subscriber notification preferences for all channels |
update_subscriber_preferences | Update subscriber notification preferences for specific channels |
Workflow management
These tools let you create, inspect, and manage notification workflows:
| Tool | Description |
|---|---|
create_workflow | Create a new workflow with comprehensive configuration including steps |
get_workflow | Get detailed information about a specific workflow |
get_workflows | Get all available workflows |
update_workflow | Update an existing workflow |
delete_workflow | Delete an existing workflow by its unique identifier |
Triggering and events
These tools let you execute workflows and manage pending notifications:
| Tool | Description |
|---|---|
trigger_workflow | Trigger a workflow to send notifications to a subscriber |
bulk_trigger_workflow | Trigger multiple workflows in a single API call |
cancel_triggered_event | Cancel a pending triggered event |
Notifications
These tools let you inspect delivery and execution data:
| Tool | Description |
|---|---|
get_notification | Get a specific notification by ID with detailed execution logs |
get_notifications | Get notifications and events with advanced filtering options |
Integrations
These tools let you manage the channel providers connected to your Novu account:
| Tool | Description |
|---|---|
get_integrations | List all channel integrations (email, SMS, push, chat, in-app) |
get_active_integrations | List only the active integrations |
delete_integration | Delete an integration by its integrationId |
set_primary_integration | Mark an integration as the primary for its channel |
Troubleshooting
If your setup isn't working, the following sections cover the most common issues.