Sendgrid MCP Server

🚀 發送網格MCP服務器

使用SendGrid MCP服務器，能夠自動化管理電子郵件營銷操作，涵蓋聯繫人管理、模板創建、統計分析等功能。藉助Cline集成，你可直接在VSCode中調用這些功能，讓工作流程更高效便捷。以下為你呈現詳細的安裝與配置指南。

🚀 快速開始

使用SendGrid MCP服務器可實現電子郵件營銷操作的自動化管理，通過Cline集成還能在VSCode中便捷調用功能，提升工作效率。

✨ 主要特性

• 聯繫人管理：提供獲取、添加和刪除聯繫人的功能。
• 模板管理：支持創建、列出、獲取和刪除動態模板。
• 統計與分析：可獲取發送統計信息並驗證電子郵件地址的有效性。
• 賬戶設置：能列出已驗證發件人和退訂組。

📦 安裝指南

克隆倉庫

git clone https://github.com/Garoth/sendgrid-mcp.git
cd sendgrid-mcp
npm install

配置環境變量

1. 獲取你的SendGrid API密鑰：
   • 登錄到你的SendGrid賬戶。
   • 轉到設置 > API密鑰。
   • 創建一個具有完整權限的新API密鑰。
2. 將其安全地保存在.env文件中：

SENDGRID_API_KEY=your-api-key-here

配置Cline MCP設置（在VSCode的全局存儲路徑下的cline_mcp_settings.json）

{
    "mcpServers": {
        "sendgrid": {
            "command": "node",
            "args": ["/path/to/sendgrid-mcp/build/index.js"],
            "env": {
                "SENDGRID_API_KEY": "your-api-key-here"
            },
            "disabled": false,
            "autoApprove": [
                "list_contacts",
                "list_contact_lists",
                "list_templates",
                "list_single_sends",
                "get_single_send",
                "list_verified_senders",
                "list_suppression_groups",
                "get_stats",
                "validate_email"
            ]
        }
    }
}

💻 使用示例

基礎用法

以下展示瞭如何使用list_contacts和create_template功能：

# 列出所有聯繫人
node /path/to/sendgrid-mcp/build/index.js list_contacts

# 創建新模板
node /path/to/sendgrid-mcp/build/index.js create_template

📚 詳細文檔

聯繫人管理

• list_contacts：獲取所有聯繫人。
• add_contact：添加單個或批量聯繫人。
• delete_contact：刪除指定聯繫人。

模板管理（僅支持動態模板）

• create_template：創建新模板。
• list_templates：列出所有模板。
• get_template：獲取特定模板的詳細信息。
• delete_template：刪除指定模板。

統計與分析

• get_stats：獲取發送統計信息。
• validate_email：驗證電子郵件地址的有效性。

賬戶設置

• list_verified_senders：列出所有已驗證發件人。
• list_suppression_groups：列出所有退訂組。

🔧 技術細節

測試環境配置

1. 複製示例環境文件：

cp .env.example .env

2. 在.env文件中添加你的SendGrid API密鑰：

SENDGRID_API_KEY=your-api-key-here

3. 運行測試：

npm test

構建項目

npm run build

⚠️ 重要提示

• 發送電子郵件到列表時，必須提供suppression_group_id或custom_unsubscribe_url以符合法規要求。
• 發件人地址必須在SendGrid中進行驗證後才能使用。
• 所有模板均採用動態模板格式，支持Handlebars語法（例如：{{variable_name}}）。
• 使用Single Sends API處理所有批量發送操作，以獲得更好的跟蹤和管理功能。

📄 許可證

本項目採用MIT許可證。SendGrid標誌歸Twilio所有。