使用说明

项目简介

Gmail MCP Server 是一个实现了 Model Context Protocol (MCP) 的后端服务,它充当 LLM 应用(如 Claude)与 Gmail 邮箱之间的桥梁。通过遵循 MCP 协议,该服务器提供了一套标准化的接口,使得 LLM 能够安全、便捷地访问和操作用户的 Gmail 邮箱,从而扩展 LLM 在邮件处理和自动化方面的能力。

主要功能点

  • 邮件操作:
    • 发送新邮件、回复邮件(包括回复全部)、转发邮件,支持附件、抄送、密送等功能。
    • 强大的邮件搜索功能,支持关键词、发件人、日期范围、邮件分类等多种过滤条件。
    • 读取邮件内容,包括正文(纯文本和 HTML)、主题、发件人、收件人、抄送人、附件列表等详细信息。
    • 支持邮件草稿的创建、读取、更新、删除和发送。
  • 邮件管理:
    • 管理邮件标签,包括列出、创建、更新、删除标签,以及为邮件添加或移除标签。
    • 修改邮件状态,如标记为已读/未读、存档/取消存档、移动到垃圾箱等。
  • 高级特性:
    • 支持 Gmail 邮件分类 (Primary, Social, Promotions, Updates, Forums) 过滤。
    • 支持基于时间范围的邮件检索,如今天、昨天、过去 24 小时等。
    • 完善的附件管理功能,允许 LLM 安全地列出和下载邮件附件到指定目录。
    • 支持多发件人身份 (Send-As) 管理,允许 LLM 使用不同的邮箱地址发送邮件。
    • 灵活的时区配置,确保邮件时间和日期信息与用户所在时区一致。
  • Prompt 模板:
    • 内置丰富的 Prompt 模板,涵盖邮件的读取、发送、搜索和管理等常见操作,方便 LLM 进行调用和交互。

安装步骤

  1. 环境准备: 确保已安装 Node.js (16 或更高版本) 和 npm。
  2. 克隆仓库: 在终端执行命令 'git clone https://github.com/cristip73/MCP-email-server.git' 克隆代码仓库到本地。
  3. 进入目录: 执行 'cd MCP-email-server' 进入项目目录。
  4. 安装依赖: 运行 'npm install' 安装项目所需的依赖包。
  5. 构建项目: 运行 'npm run build' 构建服务器代码。
  6. OAuth 认证: 运行 'npm run auth' 启动 OAuth 认证流程。按照终端提示,在浏览器中完成 Gmail 账户授权。认证成功后,关闭浏览器窗口即可。

服务器配置

MCP 服务器需要配置在 MCP 客户端中才能使用。以下是 Claude Desktop 的配置示例 (JSON 格式):

{
  "mcpServers": {
    "email-server": {
      "command": "node",
      "args": ["/path/to/email-server/build/index.js"],
      "env": {
          "TIME_ZONE": "GMT+2",
          "DEFAULT_ATTACHMENTS_FOLDER": "/Users/username/CLAUDE/Attachments"
      }
    }
  }
}
  • '"server name"': '"email-server"' (服务器名称,可自定义,在客户端中引用)
  • '"command"': '"node"' (Node.js 运行时环境)
  • '"args"': '["/path/to/email-server/build/index.js"]' (服务器入口文件路径。请将 '/path/to/email-server/build/index.js' 替换为实际的项目 'build/index.js' 文件路径)
  • '"env"': 环境变量配置,用于服务器运行时设置:
    • '"TIME_ZONE"': 时区设置,例如 '"GMT+2"' (东二区) 或 '"GMT-5"' (美国东部时间)。默认为 '"GMT+0"' (UTC 时间)。请根据您所在的时区进行设置,以确保邮件时间显示正确。
    • '"DEFAULT_ATTACHMENTS_FOLDER"': 附件保存的默认文件夹路径,例如 '" /Users/username/CLAUDE/Attachments"'。请设置为您希望保存邮件附件的本地目录。请确保该目录已存在,并且 LLM 应用有写入权限

基本使用方法

  1. 启动 MCP 服务器: 配置完成后,MCP 服务器会在客户端启动时自动运行。
  2. 在 LLM 中使用: 在支持 MCP 协议的 LLM 应用(如 Claude)中,即可通过自然语言指令调用 Gmail MCP 服务器提供的功能。例如,您可以指示 Claude 发送邮件、查询最近的邮件、搜索特定邮件、或者管理邮件标签等。
  3. 参考工具和 Prompt: 详细的工具列表和 Prompt 模板请参考仓库 README 文档的 "Available Tools" 和 "Example Prompts" 章节,以便了解如何更有效地利用 Gmail MCP 服务器的功能。

注意: 'DEFAULT_ATTACHMENTS_FOLDER' 环境变量的设置至关重要,请务必配置一个有效的、LLM 应用可以访问的本地目录,以确保附件下载和保存功能正常工作。

信息

分类

通信与社交