MCP 服务器

Novu MCP Server

使 AI 代理能够与 Novu 的通知系统进行交互，从而促进发送通知、管理订阅者和组织主题等操作。

README

Novu MCP 实现

这是一个 Novu 的模型上下文协议 (MCP) 服务器的 TypeScript 实现，允许 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"
    }
  }
}