Sendgrid MCP Server

🚀 SendGrid MCP Server

Automate email marketing operations, including contact management, template creation, and statistical analysis, with the SendGrid MCP Server. Integrate with Cline in VSCode for a more efficient workflow.

🚀 Quick Start

The SendGrid MCP Server enables you to automate email marketing operations, covering contact management, template creation, statistical analysis, etc. Through Cline integration, you can directly invoke these functions in VSCode, making your workflow more efficient and convenient. The following is a detailed installation and configuration guide.

📦 Installation

1. Clone the repository:

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

2. Configure environment variables:

   • Obtain your SendGrid API key:
     • Log in to your SendGrid account.
     • Navigate to Settings > API Keys.
     • Create a new API key with full permissions.
     • Securely store it in the .env file:

       SENDGRID_API_KEY=your-api-key-here
       

3. Configure Cline MCP settings (in cline_mcp_settings.json under the global storage path of VSCode):

   {
     "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"
         ]
       }
     }
   }
   

✨ Features

Contact Management

• list_contacts: Retrieve all contacts.
• add_contact: Add single or multiple contacts.
• delete_contact: Delete a specified contact.

Template Management (Supports dynamic templates only)

• create_template: Create a new template.
• list_templates: List all templates.
• get_template: Get detailed information about a specific template.
• delete_template: Delete a specified template.

Statistics and Analysis

• get_stats: Obtain sending statistics.
• validate_email: Validate the validity of an email address.

Account Settings

• list_verified_senders: List all verified senders.
• list_suppression_groups: List all suppression groups.

🔧 Technical Details

Test Environment Configuration

1. Copy the example environment file:

   cp .env.example .env
   

2. Add your SendGrid API key to the .env file:

   SENDGRID_API_KEY=your-api-key-here
   

3. Run tests:

   npm test
   

Build the Project

npm run build

📄 License

This project is licensed under the MIT License.

The SendGrid logo is owned by Twilio.

⚠️ Important Note

When sending emails to a list, you must provide a suppression_group_id or custom_unsubscribe_url to comply with regulatory requirements.

⚠️ Important Note

The sender address must be verified in SendGrid before use.

⚠️ Important Note

All templates use the dynamic template format and support Handlebars syntax (e.g., {{variable_name}}).

⚠️ Important Note

Use the Single Sends API to handle all bulk sending operations for better tracking and management.