Email MCP

🚀 Email-MCP Service

An email sending service based on the MCP protocol that allows AI assistants to automatically send emails through a standardized interface.

🚀 Quick Start

This is an email sending service based on the MCP protocol, which enables AI assistants to automatically send emails via a standardized interface. Although it has only been tested with the Java service integrated with Spring - AI so far, this service theoretically applies to all AI assistants and clients that support the MCP protocol.

⚠️ Important Note

Currently, it only supports the local running environment.

📦 Installation

1. Clone the repository

   git clone [repository address]
   cd email-mcp
   

2. Install dependencies

   npm install
   

3. Build the project

   npm run build
   

📚 Documentation

Configuration and Running

If you want to clone the repository and run it locally, use the following configuration:

{
  "mcpServers": {
    "email-mcp": {
      "command": "node",
      "args": [
        "yourpath\\email-mcp\\build\\server.js",
        "--verbose"
      ],
      "env": {}
    }
  }
}

⚠️ Important Note

Please replace yourpath with your actual project path.

Usage Guide

Sending Emails

When interacting with the AI assistant, you can send an email by providing the following required parameters:

• SMTP server hostname (e.g., smtp.exmail.qq.com)
• Port number (e.g., 465)
• Sender's email address (e.g., xxx@xx.com)
• Sender's password (e.g., *****)
• Recipient's email address (e.g., xxx@qq.com)
• Email subject
• Email body

Example:

The SMTP server hostname is smtp.exmail.qq.com, the port is 465, the sender's email is xxx@xx.com, the sender's password is *****, the recipient is xxx@qq.com, the body is 'Hello, long time no see', and the subject is 'Test'.

💻 Development and Contribution

If you have any problems, please feel free to submit an issue. Let's make progress together!

📄 License

This project is licensed under the Apache License. Please refer to the LICENSE file for details.

Badges