Gmail MCP

Gmail MCP

site icon
2025.04.04 2
JavaScript电子邮件管理自动化操作交流协作
Gmail MCP 是一个基于 Model Context Protocol (MCP) 的实现,为 Gmail API 提供了标准化的接口,用于电子邮件管理、发送和检索。它覆盖了 Gmail API 的所有功能,包括消息、线程、标签、草稿和设置管理,支持 OAuth2 安全认证。
View on GitHub

Overview

基本能力

产品定位

Gmail MCP 是一个为 Gmail API 提供标准化接口的服务,专注于电子邮件管理和自动化操作。

核心功能

  • 完整的 Gmail API 覆盖,包括消息、线程、标签、草稿和设置管理
  • 支持发送、起草和管理电子邮件
  • 标签管理,包括自定义颜色和可见性设置
  • 线程操作,用于会话管理
  • 设置管理,包括假期自动回复、IMAP/POP 和语言设置
  • 邮箱变更历史跟踪
  • 使用 Google Cloud 凭证的 OAuth2 安全认证

适用场景

  • 自动化电子邮件发送和管理
  • 批量处理邮件(如标签修改、删除)
  • 邮件过滤和转发设置管理
  • 假期自动回复设置
  • 邮件客户端集成

工具列表

  • Heimdall:用于限制暴露给客户端应用程序的端点数量
  • Smithery:用于自动安装和配置 Gmail MCP

常见问题解答

  • 认证问题:确保选择 "Desktop app" 作为应用程序类型,否则服务器无法解析 JSON 文件中的密钥
  • 端口冲突:默认使用端口 3000 监听 OAuth 响应,可通过设置 AUTH_SERVER_PORT 更改

使用教程

使用依赖

  1. 前往 Google Cloud Console
  2. 创建或选择现有项目
  3. 为项目启用 Gmail API
  4. 在凭据中创建 OAuth 2.0 客户端 ID
  5. 选择 "Desktop app" 作为应用程序类型
  6. 下载客户端凭据 JSON 文件
  7. 将下载的凭据文件保存到 ~/.gmail-mcp/gcp-oauth.keys.json

安装教程

NPX(推荐)

在 MCP 客户端的 config.json 中添加以下内容:

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

手动下载

  1. 克隆仓库:
git clone https://github.com/shinzo-labs/gmail-mcp.git
  1. 安装依赖并构建:
pnpm i && pnpm run build
  1. config.json 中添加以下内容:
{
  "mcpServers": {
    "gmail": {
      "command": "node",
      "args": [
        "/path/to/gmail-mcp/dist/index.js"
      ]
    }
  }
}

Smithery

自动安装:

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

调试方式

自动化认证(推荐)

  1. 获取 OAuth 凭据并下载 JSON 文件
  2. 重命名为 gcp-oauth.keys.json 并复制到 $HOME/.gmail-mcp/
  3. 运行认证命令:
npx @shinzolabs/gmail-mcp auth

pnpm i && pnpm run build && pnpm run auth
  1. 浏览器将自动打开 Google OAuth 同意屏幕
  2. 授权后关闭浏览器窗口
  3. 令牌将自动保存到 $HOME/.gmail-mcp/credentials.json

手动认证(建议用于 Docker)

通过环境变量提供凭据:

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

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。