Gmail MCP

by shinzo-labs
Verified
MIT License
126
1
  • Apple
  • Linux

local-only server

The server can only run on the client’s local machine because it depends on local resources.

Integrations

  • Provides comprehensive Gmail API access including sending/drafting emails, message and thread management, label operations, attachment handling, settings configuration (vacation responder, IMAP/POP), and mailbox history tracking.

  • Enables OAuth2 authentication using Google Cloud credentials for secure access to Gmail services.

Gmail 多账户管理平台

Gmail API 的模型上下文协议 (MCP)实现,为电子邮件管理、发送和检索提供标准化接口。

特征

  • 完整的 Gmail API 覆盖范围,包括消息、线程、标签、草稿和设置
  • 支持发送、起草和管理电子邮件
  • 具有可自定义颜色和可见性设置的标签管理
  • 对话管理的线程操作
  • 设置管理,包括休假回复、IMAP/POP 和语言设置
  • 邮箱更改的历史记录跟踪
  • 使用您的 Google Cloud 凭据进行安全 OAuth2 身份验证

安装

⚠️ 注意:由于此服务器上可用的端点数量众多,建议您安装并设置Heimdall以限制暴露给客户端应用程序的端点数量。

要使用此 MCP,您需要设置 Gmail 身份验证:

  1. 前往Google Cloud Console
  2. 创建新项目或选择现有项目
  3. 为您的项目启用 Gmail API
  4. 转到凭证并创建 OAuth 2.0 客户端 ID
    • 选择“桌面应用程序”作为应用程序类型(警告:如果您不选择此类型,服务器将无法解析 JSON 文件中的密钥)
    • 下载客户端凭据 JSON 文件
  5. 将下载的凭证文件保存到~/.gmail-mcp/gcp-oauth.keys.json

NPX(推荐)

将以下内容添加到您的 MCP 客户端config.json (如果使用 Heimdall ~/.heimdall/config.json ):

{ "mcpServers": { "gmail": { "command": "npx", "args": [ "@shinzolabs/gmail-mcp" ] } } }

手册下载

  1. 下载 repo:
git clone https://github.com/shinzo-labs/gmail-mcp.git
  1. 安装软件包并构建(在克隆的 repo 内):
pnpm i && pnpm run build
  1. 将以下内容添加到您的 MCP 客户端config.json (如果使用 Heimdall ~/.heimdall/config.json ):
{ "mcpServers": { "gmail": { "command": "node", "args": [ "/path/to/gmail-mcp/dist/index.js" ] } } }

锻造工艺

要通过Smithery自动安装 Claude Desktop:

npx -y @smithery/cli install @shinzo-labs/gmail-mcp --client claude

验证

自动化(推荐)

此 MCP 提供自动身份验证流程:

  1. 首先,获取 OAuth 凭证并下载 JSON 文件。
  2. 将 JSON 文件重命名为gcp-oauth.keys.json并将其复制到$HOME/.gmail-mcp/ ,或者复制到MCP_CONFIG_DIR中设置的任何位置。
  3. 运行身份验证命令:
# If using npx npx @shinzolabs/gmail-mcp auth # If in the project directory pnpm i && pnpm run build && pnpm run auth
  1. 浏览器窗口将自动打开至 Google OAuth 同意屏幕
  2. 授予访问权限后,您可以关闭浏览器窗口
  3. 令牌将自动保存到$HOME/.gmail-mcp/credentials.json

MCP 将自动:

  • 管理令牌刷新
  • 将凭据保存到磁盘
  • 处理 OAuth 回调
  • 在默认浏览器中打开身份验证 URL

注意:此服务器默认使用3000端口监听 OAuth 响应。如果您在3000上运行了其他服务,可以将AUTH_SERVER_PORT设置为其他端口。

您可以在运行命令之前通过设置MCP_CONFIG_DIR来自定义配置位置(可选):

export MCP_CONFIG_DIR=/custom/path/to/directory/

手动(建议用于 Docker 使用)

如果您愿意,您也可以直接通过环境变量提供凭据:

export CLIENT_ID=your-id export CLIENT_SECRET=your-secret export REFRESH_TOKEN=your-refresh-token

支持的端点

用户管理

  • get_profile :获取当前用户的 Gmail 个人资料
  • stop_mail_watch :停止接收推送通知
  • watch_mailbox :设置邮箱更改的推送通知

消息管理

管理消息

  • list_messages :列出带有可选过滤的消息
  • get_message :获取特定消息
  • get_attachment :获取消息附件
  • modify_message消息标签
  • send_message :向指定收件人发送电子邮件消息
  • delete_message :永久删除消息
  • trash_message :将消息移至垃圾箱
  • untrash_message :从垃圾箱中删除消息
  • batch_modify_messages :修改多条消息
  • batch_delete_messages :删除多条消息

标签管理

  • list_labels :列出所有标签
  • get_label :获取特定标签
  • create_label :创建新标签
  • update_label :更新标签
  • patch_label :标签的部分更新
  • delete_label :删除标签

线程管理

  • list_threads :列出电子邮件线程
  • get_thread :获取特定线程
  • modify_thread线程标签
  • trash_thread :将线程移至垃圾箱
  • untrash_thread :从垃圾箱中删除线程
  • delete_thread :删除线程

草稿管理

  • list_drafts :列出用户邮箱中的草稿
  • get_draft :通过 ID 获取特定草稿
  • create_draft :在 Gmail 中创建电子邮件草稿
  • update_draft :替换草稿的内容
  • delete_draft :删除草稿
  • send_draft :发送现有草稿

设置管理

自动转发

  • get_auto_forwarding :获取自动转发设置
  • update_auto_forwarding :更新自动转发设置

IMAP 设置

  • get_imap :获取 IMAP 设置
  • update_imap :更新 IMAP 设置

POP 设置

  • get_pop :获取 POP 设置
  • update_pop :更新 POP 设置

休假响应者

  • get_vacation :获取休假响应者设置
  • update_vacation :更新休假响应者

语言设置

  • get_language :获取语言设置
  • update_language :更新语言设置

代表

  • list_delegates :列出账户代表
  • get_delegate :获取特定委托
  • add_delegate :添加代表
  • remove_delegate :删除委托

过滤器

  • list_filters :列出电子邮件过滤器
  • get_filter :获取特定过滤器
  • create_filter :创建一个新的过滤器
  • delete_filter :删除过滤器

转发地址

  • list_forwarding_addresses :列出转发地址
  • get_forwarding_address :获取特定的转发地址
  • create_forwarding_address :创建转发地址
  • delete_forwarding_address :删除转发地址

发送方式设置

  • list_send_as :列出 send-as 别名
  • get_send_as :获取特定的 send-as 别名
  • create_send_as :创建 send-as 别名
  • update_send_as :更新 send-as 别名
  • patch_send_as :部分更新 send-as 别名
  • verify_send_as :发送验证邮件
  • delete_send_as :删除 send-as 别名

S/MIME 设置

  • list_smime_info :列出 S/MIME 配置
  • get_smime_info :获取特定的 S/MIME 配置
  • insert_smime_info :上传新的 S/MIME 配置
  • set_default_smime_info :设置默认 S/MIME 配置
  • delete_smime_info :删除 S/MIME 配置

贡献

欢迎并鼓励您积极投稿。如有任何疑问、意见或顾虑,请联系austin@shinzolabs.com

You must be authenticated.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

使用 60 多种工具轻松管理您的电子邮件,用于起草、发送、检索和整理邮件。通过全面的 Gmail API 覆盖(包括标签和线程管理),简化您的电子邮件工作流程。

  1. Features
    1. Installation
      1. NPX (Recommended)
      2. Manual Download
      3. Smithery
    2. Authentication
      1. Automated (recommended)
      2. Manual (suggested for Docker usage)
    3. Supported Endpoints
      1. User Management
      2. Message Management
      3. Label Management
      4. Thread Management
      5. Draft Management
      6. Settings Management
    4. Contributing
      ID: 1je9b8hapn