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所有。