项目简介

Novu MCP Server 是一个 Model Context Protocol (MCP) 服务器的 TypeScript 实现，旨在让 AI Agent 能够通过 MCP 协议与 Novu 的通知基础设施进行交互。它允许 AI Agent 利用 Novu 的功能，例如发送通知、管理用户订阅和主题等。

主要功能点

• 通过 MCP 协议与客户端通信，接收 JSON-RPC 格式的请求。
• 支持以下 Novu 操作：
  • 事件管理 (触发事件、广播事件、取消事件)
  • 通知管理 (获取通知列表、获取通知统计)
  • 订阅者管理 (获取订阅者列表、创建订阅者、更新订阅者、删除订阅者)
  • 主题管理 (获取主题列表、创建主题、删除主题、添加/移除主题订阅者)
• 通过标准输入/输出 (stdio) 进行通信。

安装步骤

1. 确保已安装 Node.js 和 npm。
2. 克隆或下载此仓库到本地。
3. 在项目根目录下打开终端，运行 'npm install' 安装依赖。
4. 运行 'npm run build' 构建项目。

服务器配置

MCP 客户端需要配置以下信息以连接到 Novu MCP 服务器：

{
  "serverName": "NovuMCP",
  "command": "npm",
  "args": ["start"]
}

• 'serverName': 服务器名称，可以自定义。
• 'command': 启动服务器的命令，这里使用 'npm'。
• 'args': 传递给 'npm' 命令的参数，'start' 脚本会启动服务器。

注意: 确保环境变量 'NOVU_API_KEY' 已配置为您的 Novu API 密钥。您可以在 'smithery.yml' 文件或系统环境变量中设置。

基本使用方法

1. 启动 MCP 服务器 (运行 'npm start')。
2. MCP 客户端通过 stdio 向服务器发送 JSON-RPC 请求。
3. 服务器处理请求并返回 JSON-RPC 响应。

例如，发送触发事件的请求：

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