使用说明

项目简介

MailPace MCP 邮件发送服务是一个实现了 Model Context Protocol (MCP) 的服务器，它利用 MailPace 强大的事务邮件 API，为大型语言模型（LLM）客户端提供便捷的邮件发送功能。通过简单的工具调用，LLM 应用可以轻松集成邮件发送能力，无需复杂的 API 对接和管理。

主要功能点

邮件发送工具 (send-email): 提供一个名为 'send-email' 的工具，允许 LLM 客户端调用以发送邮件。
- 支持发送 HTML 或纯文本邮件。
- 支持抄送 (CC)、密送 (BCC)、回复地址 (Reply-To) 等常用邮件头设置。
- 支持添加附件，包括文件名、内容 (base64 编码) 和内容类型。
- 支持邮件标签 (Tags) 功能，方便邮件分类和追踪。
- 详细的输入参数请参考 MailPace 文档。

安装步骤

安装 Smithery (推荐): 如果你的 LLM 客户端支持 Smithery，可以使用以下命令快速安装 MailPace MCP 服务器：

npx -y @smithery/cli install @mailpace/mailpace-mcp --client claude

按照提示完成安装即可。

手动安装:
- 确保已安装 Node.js 和 npm。
- 克隆或下载此仓库的代码。
- 在项目根目录下运行 'npm install' 安装依赖。
- 运行 'npm run build' 构建项目。

服务器配置

MCP 客户端需要配置以下信息才能连接到 MailPace MCP 服务器。以下是 JSON 格式的配置示例，请根据你的 MCP 客户端进行配置：

{
  "serverName": "transactional-email-sending-service",  // 服务器名称，用于在客户端中标识
  "command": "npm",                           // 启动服务器的命令，这里使用 npm
  "args": ["run", "start", "--", "--token", "<YOUR_MAILPACE_API_TOKEN>"] // 启动命令的参数，run start 是 npm 运行脚本，--token 用于传递 MailPace API Token，请替换 <YOUR_MAILPACE_API_TOKEN> 为你的实际 Token
  // 或者，如果你希望使用环境变量传递 Token，可以将 args 修改为 ["run", "start"]，并在运行环境中设置 MAILPACE_API_TOKEN 环境变量
}

配置说明:

'serverName': 服务器的唯一名称，客户端通过此名称识别服务。固定值为 'transactional-email-sending-service'。
'command': 启动服务器的可执行命令。由于项目使用 npm 管理，这里设置为 'npm'。
'args': 启动命令的参数数组。
- 'run start': 告诉 npm 运行 'package.json' 中定义的 'start' 脚本，该脚本会启动 MCP 服务器。
- '--': 用于分隔 npm 参数和传递给 'start' 脚本的参数。
- '--token <YOUR_MAILPACE_API_TOKEN>': 通过命令行参数传递 MailPace API Token。请务必替换 '<YOUR_MAILPACE_API_TOKEN>' 为你在 MailPace 官网创建的 Domain API Token。
- 环境变量 (可选): 你也可以选择不使用 '--token' 参数，而是将 MailPace API Token 设置为环境变量 'MAILPACE_API_TOKEN'。在这种情况下，'args' 可以简化为 '["run", "start"]'。

获取 MailPace API Token:

访问 MailPace 官网并创建组织和域名。
登录后，在域名设置中找到 "API Tokens" 部分，复制你的 Domain API Token。

基本使用方法

配置完成后，在你的 LLM 客户端中，你可以通过调用 'send-email' 工具来发送邮件。你需要提供工具所需的输入参数，例如 'from', 'to', 'subject', 'textbody' 或 'htmlbody' 等。具体的参数定义请参考工具定义部分和 MailPace 文档。

示例 (假设你的 LLM 客户端支持 JSON 格式的工具调用):

{
  "tool_call": {
    "tool_name": "send-email",
    "parameters": {
      "from": "[email protected]",
      "to": "[email protected]",
      "subject": "来自 LLM 的邮件",
      "textbody": "这是一封由 LLM 应用通过 MailPace MCP 服务器发送的测试邮件。"
    }
  }
}

LLM 客户端会将上述 JSON 请求发送给 MailPace MCP 服务器，服务器会调用 MailPace API 发送邮件，并将发送结果返回给客户端。

关键词