Brevo MCP

🚀 Brevo MCP 服務器

📧 藉助官方 SDK 實現 Claude 和 Smithery 與 Brevo API 的全面集成

這是一個功能全面的 MCP 服務器，它藉助官方的 @getbrevo/brevo Node.js SDK，讓 Claude 能夠全面訪問 Brevo 的營銷自動化平臺。該服務器擁有 8 個精心組織的工具，涵蓋了 Brevo 的所有主要功能。

✨ 主要特性

• 🔧 官方 Brevo SDK：基於 @getbrevo/brevo 構建，具備極高的兼容性。
• 📧 郵件操作：支持事務性郵件、模板管理、郵件跟蹤和事件處理。
• 📱 短信與 WhatsApp：可發送短信、管理營銷活動，還能集成 WhatsApp。
• 👥 聯繫人管理：涵蓋聯繫人、聯繫人列表、聯繫人屬性管理以及批量操作。
• 🎯 營銷活動管理：支持郵件和短信營銷活動的創建、調度和分析。
• 💬 對話管理：負責聊天和對話的管理。
• 🔗 Webhook：實現基於事件的自動化和通知功能。
• 🛒 電子商務：支持訂單、產品和類別集成。
• 🏢 賬戶管理：可管理發件人、域名、文件夾和賬戶信息。
• 🚀 與 Smithery 兼容：可隨時部署到 Smithery。
• 🛡️ 類型安全：全面支持 TypeScript。

🚀 快速開始

選項 1：使用 Smithery（推薦）

1. 在 Smithery 中進行配置：

brevo-mcp:
  apiKey: "your-brevo-api-key"           # 必需
  defaultSenderEmail: "your@domain.com" # 可選
  defaultSenderName: "Your Name"        # 可選

選項 2：本地安裝

1. 安裝依賴：

npm install
npm run build

2. 設置環境變量：

export BREVO_API_KEY="your-brevo-api-key"
export BREVO_DEFAULT_SENDER_EMAIL="your@domain.com"
export BREVO_DEFAULT_SENDER_NAME="Your Name"

3. 啟動服務：

npm start

💻 使用示例

基礎用法

以下是一些不同工具的使用示例：

聯繫人管理（contacts）

{
  "operation": "bulk_import",
  "contacts": [
    {
      "email": "user1@example.com",
      "attributes": {
        "FIRSTNAME": "John",
        "LASTNAME": "Doe"
      }
    }
  ]
}

事務性郵件（email）

{
  "operation": "send",
  "to": [{"email": "recipient@example.com", "name": "John Doe"}],
  "subject": "Welcome to our service",
  "htmlContent": "<h1>Welcome!</h1><p>Thank you for joining us.</p>",
  "sender": {"email": "noreply@yourcompany.com", "name": "Your Company"}
}

營銷活動（campaigns）

{
  "operation": "create_email_campaign",
  "campaignData": {
    "name": "Newsletter Campaign",
    "subject": "Monthly Newsletter",
    "htmlContent": "<h1>Newsletter</h1>",
    "recipients": {"listIds": [1, 2]}
  }
}

短信操作（sms）

{
  "operation": "send_batch",
  "recipients": ["+1234567890", "+0987654321"],
  "content": "Your order is ready for pickup!",
  "sender": "YourBrand"
}

Webhook（webhooks）

{
  "operation": "create_webhook",
  "url": "https://your-app.com/brevo-webhook",
  "events": ["delivered", "opened", "clicked"],
  "description": "Email tracking webhook",
  "type": "transactional"
}

電子商務（ecommerce）

{
  "operation": "create_order",
  "orderData": {
    "id": "order-123",
    "email": "customer@example.com",
    "products": [
      {
        "id": "product-1",
        "name": "Widget",
        "price": 29.99,
        "quantity": 2
      }
    ],
    "total": 59.98
  }
}

高級用法

批量聯繫人導入

{
  "operation": "bulk_import",
  "contacts": [
    {
      "email": "user1@example.com",
      "attributes": {
        "FIRSTNAME": "John",
        "LASTNAME": "Doe",
        "COMPANY": "Acme Corp"
      }
    }
  ]
}

帶跟蹤功能的郵件營銷活動

{
  "operation": "create_email_campaign",
  "campaignData": {
    "name": "Product Launch",
    "subject": "Introducing Our New Product",
    "htmlContent": "<h1>New Product Launch</h1>",
    "recipients": {"listIds": [1]},
    "scheduler": {
      "sendAt": "2024-01-01T10:00:00Z"
    }
  }
}

電子商務訂單跟蹤

{
  "operation": "create_order",
  "orderData": {
    "id": "order-456",
    "email": "customer@example.com",
    "products": [
      {"id": "prod-1", "name": "T-Shirt", "price": 25.00, "quantity": 1}
    ],
    "total": 25.00,
    "status": "pending"
  }
}

📚 詳細文檔

📋 配置

環境變量

Smithery 配置

version: 1
startCommand:
  type: stdio
  configSchema:
    type: object
    required: ['apiKey']
    properties:
      apiKey:
        type: string
        description: "用於身份驗證的 Brevo API 密鑰（必需）"
      defaultSenderEmail:
        type: string
        description: "默認發件人郵箱地址"
      defaultSenderName:
        type: string
        description: "默認發件人姓名"
      debug:
        type: boolean
        description: "啟用調試模式"
        default: false

🔧 開發

# 安裝依賴
npm install

# 構建項目
npm run build

# 啟動服務器
npm start

# 測試服務器
npm test

# 使用 Smithery 運行
npm run smithery

🔧 技術細節

• API 密鑰安全：通過環境變量安全處理 API 密鑰。
• 通信安全：所有通信均通過官方 Brevo SDK 使用 HTTPS 協議。
• 輸入驗證：對所有工具參數進行輸入驗證。
• 錯誤處理：完善的錯誤處理機制可防止信息洩露。

📄 許可證

本項目採用 MIT 許可證。

🆘 支持

• 問題反饋：請在 GitHub 上提交問題。
• Brevo API 文檔：https://developers.brevo.com/
• 官方 SDK：https://github.com/getbrevo/brevo-node

本項目使用官方 Brevo Node.js SDK 構建，確保了最高的可靠性和豐富的功能 ❤️