maildev-mcp

MailDevMcp

English | 日本語

mcp-name: io.github.pierre3/maildev-mcp

一个用于 MailDev 的 MCP（Model Context Protocol） 服务。
可直接通过 AI 驱动的编辑器或 MCP 客户端管理 MailDev Docker 容器并检查收到的电子邮件。

此服务适用于本地开发和测试自动化场景，在这些场景中，MCP 客户端需要：

• 启动或停止 MailDev 容器
• 检查收件箱内容
• 触发应用程序行为后等待邮件
• 检查 HTML 正文和附件
• 逐字节验证附件完整性

安装

安装为全局 .NET 工具：

dotnet tool install -g MailDevMcp

安装后，maildev-mcp 命令即可使用。

MCP 客户端配置

将以下内容添加到 MCP 客户端设置中（例如 Claude Desktop、VS Code 等）：

{
  "mcpServers": {
    "maildev-mcp": {
      "command": "maildev-mcp",
      "env": {
        "MAILDEV_API_PORT": "1080"
      }
    }
  }
}

环境变量

变量	默认值	描述
MAILDEV_API_PORT	1080	MailDev REST API 的端口号

典型工作流

1. 调用 StartMaildev 启动本地 MailDev 容器
2. 触发应用程序发送电子邮件
3. 如果邮件投递是异步的，则调用 WaitForEmail
4. 使用 ListEmails、SearchEmails 或 GetEmail 检查结果
5. 需要进行更深入的验证时，使用 GetEmailHtml、GetAttachmentContent 或 VerifyAttachment
6. 使用 DeleteEmail、DeleteAllEmails 或 StopMaildev 清理

可用工具

工具	描述
StartMaildev	启动 MailDev Docker 容器，可配置 SMTP 端口、API 端口、身份验证和 TLS
StopMaildev	停止并移除 MailDev Docker 容器
MaildevStatus	检查 MailDev 的运行状态
ListEmails	获取已收到电子邮件的列表
GetEmail	按 ID 获取电子邮件详情，包括附件信息
GetEmailHtml	按 ID 获取电子邮件的 HTML 正文
SearchEmails	按主题、发件人或收件人搜索已收到的电子邮件
DeleteEmail	按 ID 删除单封电子邮件
DeleteAllEmails	删除所有已收到的电子邮件
WaitForEmail	等待符合指定条件的新邮件到达（适用于测试自动化）
GetAttachmentContent	获取电子邮件附件的原始 Base64 编码内容
VerifyAttachment	通过逐字节比较，验证电子邮件附件是否与原始数据一致

工具行为说明

• StartMaildev
  • 支持自定义 SMTP 和 API 端口
  • 支持可选的 SMTP 身份验证
  • 空凭据或仅包含空白字符的凭据将被视为未启用身份验证
  • 支持使用生成的自签名证书启用 TLS
• GetEmail 和 ListEmails
  • 将缺失或为空的主题显示为 (no subject)
  • 将缺失的地址列表显示为 (none)
• WaitForEmail
  • 持续轮询 MailDev，直到符合条件的邮件到达或超时
  • 如果轮询期间发生暂时性的 MailDev 连接失败，会在返回的消息中报告
• VerifyAttachment
  • 接受 Base64 编码的原始负载
  • 逐字节比较收到的附件
  • 报告完全匹配、大小不匹配或内容不匹配

要求和假设

• 必须在运行此 MCP 服务的同一台机器上安装 Docker，并确保其可用
• 通过 localhost 上的 HTTP API 访问 MailDev
• MCP 客户端中配置的 API 端口必须与 Docker 暴露的 MailDev API 端口一致

先决条件

• .NET 10 SDK 或更高版本
• Docker（用于运行 MailDev 容器）

从源代码构建

git clone https://github.com/pierre3/MailDevMcp.git
cd MailDevMcp
dotnet pack -c Release
dotnet tool install -g --add-source ./bin/Release MailDevMcp

许可证

MIT