Novu

🚀 Novu MCP 実装

このプロジェクトは、TypeScript で書かれた Novu 通知基盤のモデルコンテキストプロトコル（MCP）サーバーの実装です。AI エージェントが Novu の通知システムとやり取りできるようにします。

🚀 クイックスタート

セットアップ

1. 依存関係をインストールします：

npm install

2. プロジェクトをビルドします：

npm run build

3. MCP サーバーを起動します：

npm start

開発時には、以下のコマンドを使用できます：

npm run dev

設定

MCP サーバーは、smithery.yml で Novu API キーを設定する必要があります。API キーは、Novu ダッシュボードから取得できます。

✨ 主な機能

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 で実装されています。