项目简介

Gmail MCP 是一个实现了 Model Context Protocol (MCP) 的服务器应用。它作为LLM客户端(如AI助手)与您的Gmail账户之间的桥梁,将复杂的Gmail API操作抽象为标准化的工具(Tools),使AI能够理解并执行发送邮件、读取邮件、管理标签等任务,从而提供智能化的邮件处理能力。

主要功能点

  • 邮件管理: 查看、发送、起草、修改、删除邮件,以及对邮件进行归档或标记为垃圾邮件。
  • 标签与会话管理: 列出、获取、创建、更新、删除Gmail标签;获取、修改、归档、删除邮件会话(Thread)。
  • 高级设置控制: 访问和修改自动转发、IMAP/POP、语言、外出自动回复等账户设置。
  • 委派与过滤器: 管理账户委派人、创建和删除邮件过滤器。
  • 发送别名与S/MIME: 管理“发送别名”设置,包括创建、更新、删除和验证;管理S/MIME配置。
  • 附件获取: 获取特定邮件的附件。
  • 用户信息: 获取当前连接用户的Gmail个人资料。
  • 推送通知: 设置或停止接收邮箱变化的推送通知。
  • 安全认证: 支持安全的OAuth2认证流程,通过Google Cloud Credentials连接您的Gmail账户。

安装步骤

  1. Google API客户端设置 (每个组织/用户一次):

    • 前往 Google Cloud Console 并创建一个项目。
    • 为您的项目启用 Gmail API。
    • 创建 OAuth 2.0 Client ID(选择“桌面应用”或带有 'http://localhost:3000/oauth2callback' 重定向URI的“Web 应用”)。
    • 下载OAuth凭据JSON文件,并将其保存到 '~/.gmail-mcp/gcp-oauth.keys.json'。
  2. 用户OAuth认证 (每个使用此服务的用户一次):

    • 确保 '~/.gmail-mcp/gcp-oauth.keys.json' 文件位于用户电脑的正确路径。
    • 运行认证命令。这将打开浏览器窗口,引导用户完成Google账户授权流程。
    • 成功后,用户的OAuth刷新令牌和其他凭据将保存到 '~/.gmail-mcp/credentials.json' 文件中。
  3. 本地安装(使用 'npx'):

    • Gmail MCP服务器通常通过MCP客户端启动。对于本地客户端,您可以配置客户端直接运行已安装的npm包。

服务器配置 (供MCP客户端参考)

MCP客户端需要知道如何启动Gmail MCP服务器进程。这通常在客户端的配置文件中指定(例如 'config.json')。配置信息会包含服务器的名称以及启动该服务器的命令和参数。

例如,对于通过 'npx' 在本地启动服务器的情况,客户端的配置可能如下:

  • 服务器名称: 'gmail' (或其他自定义名称)
  • 启动命令 (command): 'npx'
  • 命令参数 (args): '@shinzolabs/gmail-mcp'

这个配置告诉MCP客户端,当需要与名为 'gmail' 的服务器交互时,应执行 'npx @shinzolabs/gmail-mcp' 命令来启动它。服务器启动后,会通过标准输入/输出与客户端进行MCP协议通信。

在某些托管或远程环境中,可能需要配置额外的环境变量,如 'CLIENT_ID', 'CLIENT_SECRET', 'REFRESH_TOKEN', 'GMAIL_OAUTH_PATH', 'GMAIL_CREDENTIALS_PATH' 等,以便服务器找到正确的认证信息。

基本使用方法

用户不会直接与Gmail MCP服务器交互。用户通过支持MCP协议的LLM客户端(如AI助手界面)发出请求。客户端会根据用户的意图,识别出需要调用的Gmail MCP服务器提供的工具(如发送邮件工具、列表邮件工具),并将请求通过MCP协议发送给已配置并启动的Gmail MCP服务器。服务器执行相应的Gmail API操作,并将结果通过MCP协议返回给客户端,客户端再将结果呈现给用户或用于进一步的LLM推理。

信息

分类

通信与社交