Sendgrid

🚀 SendGrid MCP Server

This project provides a server for interacting with the SendGrid API, facilitating operations such as sending emails and managing contacts.

🚀 Quick Start

📦 Installation

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

⚙️ Configuration

1. Obtain your SendGrid API key:

   • Log in to your SendGrid account.
   • Navigate to Settings > API Keys.
   • Create a new API key with full access permissions.
   • Securely save the API key, as it cannot be viewed again once generated.

2. Add it to the Cline MCP settings file in VSCode (e.g., ~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/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"
      ]
    }
  }
}

⚠️ Important Note

Tools that modify data (such as sending emails or deleting contacts) do not have auto - approval enabled by default for security reasons.

💻 Usage Examples

🔨 Development

🧪 Set up Testing

Testing uses real API calls to ensure accurate responses. To run the tests:

1. Copy the example environment file:

   cp .env.example .env
   

2. Edit .env and add your SendGrid API key:

   SENDGRID_API_KEY=your-api-key-here
   

   ⚠️ Important Note

   The .env file is ignored by git to prevent committing sensitive information.

3. Run the tests:

   npm test
   

🏗️ Build

npm run build

📚 Documentation

📋 Important Instructions

• When sending emails to a list, you must provide a suppression_group_id or custom_unsubscribe_url to comply with email regulations.
• The sender's email address must be verified in SendGrid before it can be used to send emails.
• All templates are created as dynamic templates and support Handlebars syntax (e.g., {{variable_name}}).
• The single send API is used for all bulk email operations because it provides better tracking and management capabilities.
• The SendGrid API is "eventually consistent" - data changes (such as adding contacts or updating lists) may not be immediately visible after generation.

📄 License

This project is licensed under the MIT license.

The SendGrid logo copyright belongs to Twilio.