Novu

🚀 Novu MCP Implementation

This is an implementation of a Model Context Protocol (MCP) server for the Novu notification infrastructure written in TypeScript. It allows AI agents to interact with Novu's notification system.

🚀 Quick Start

📦 Installation

1. Install dependencies:

npm install

2. Build the project:

npm run build

3. Start the MCP server:

npm start

For development, you can use:

npm run dev

⚙️ Configuration

The MCP server requires the Novu API key to be configured in smithery.yml. You can obtain the API key from your Novu dashboard.

✨ Features

The MCP server supports the following Novu operations:

Events

• trigger_event: Send a notification to a specific subscriber.
• broadcast_event: Send a notification to all subscribers.
• cancel_triggered_event: Cancel a triggered notification.

Notifications

• get_notifications: List notifications with pagination.
• get_notification_stats: Get notification statistics.

Subscribers

• get_subscribers: List subscribers with pagination.
• create_subscriber: Create a new subscriber.
• update_subscriber: Update subscriber details.
• delete_subscriber: Delete a subscriber.

Topics

• get_topics: List all topics.
• create_topic: Create a new topic.
• delete_topic: Delete an existing topic.
• add_subscribers_to_topic: Add subscribers to a topic.
• remove_subscribers_from_topic: Remove subscribers from a topic.

💻 Usage Examples

Basic Usage

Example of triggering a notification:

{
  "type": "execute",
  "payload": {
    "operation": "trigger_event",
    "params": {
      "name": "welcome-email",
      "to": "subscriber-id",
      "payload": {
        "name": "John Doe",
        "company": "Acme Inc"
      }
    }
  }
}

Example of creating a subscriber:

{
  "type": "execute",
  "payload": {
    "operation": "create_subscriber",
    "params": {
      "subscriberId": "unique-id",
      "email": "john@example.com",
      "firstName": "John",
      "lastName": "Doe"
    }
  }
}

🔧 Technical Details

The source code is written in TypeScript and follows modern development practices. The main implementation is located in src/index.ts, while Novu-specific logic is in src/novu-service.ts.