Novu

🚀 Novu MCP 實現

這是一個用 TypeScript 編寫的 Novu 通知基礎架構的模型上下文協議（MCP）服務器的實現，它允許 AI 代理與 Novu 的通知系統進行交互，為通知管理提供了便捷的解決方案。

🚀 快速開始

安裝依賴項

npm install

構建項目

npm run build

啟動 MCP 服務器

npm start

開發模式

若您處於開發階段，可以使用以下命令：

npm run dev

📦 安裝指南

MCP 服務器需要在 smithery.yml 中配置 Novu API 密鑰。您可以從您的 Novu 儀表板獲取 API 密鑰。

✨ 主要特性

MCP 服務器支持以下 Novu 操作：

事件

• trigger_event：向特定訂閱者發送通知
• broadcast_event：向所有訂閱者發送通知
• cancel_triggered_event：取消已觸發的通知

通知

• get_notifications：分頁列出通知
• get_notification_stats：獲取通知統計信息

訂閱者

• get_subscribers：分頁列出訂閱者
• create_subscriber：創建新訂閱者
• update_subscriber：更新訂閱者詳細信息
• delete_subscriber：刪除訂閱者

主題

• get_topics：列出所有主題
• create_topic：創建新主題
• delete_topic：刪除現有主題
• add_subscribers_to_topic：將訂閱者添加到主題
• remove_subscribers_from_topic：從主題中移除訂閱者

💻 使用示例

基礎用法

觸發通知

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

創建訂閱者

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

🔧 技術細節

源代碼用 TypeScript 編寫，並遵循現代開發實踐。主要實現位於 src/index.ts，而 Novu 特定的邏輯在 src/novu-service.ts 中。