Gmail MCP Server

Gmail MCP 服务

imap-mcp-server 现已专为 Gmail 设计，为 Gmail 账户提供 AI 驱动的分析和管理功能。它借助 Gmail API 实现无缝集成和高级功能。

功能

• Gmail 专属集成：专为使用 Gmail API 的 Gmail 账户打造。
• AI 驱动的分析：分析邮件模式、为邮件排序，并深入了解 Gmail 收件箱。
• 智能文件夹管理：通过自定义筛选规则创建和管理 Gmail 智能文件夹。
• Google Cloud Storage 集成：将 Gmail 邮件和附件迁移并存储到 Google Cloud Storage。
• 批量处理：根据自定义条件对 Gmail 邮件执行批量操作。

MCP 服务配置

如需在 VS Code 中使用此服务的 MCP（Model Context Protocol）功能，请将以下配置添加到 VS Code 的 settings.json 中：

"mcp": {
  "inputs": [
    {
      "type": "promptString",
      "id": "gmail-username",
      "description": "Gmail Username"
    },
    {
      "type": "promptString",
      "id": "gmail-password",
      "description": "Gmail Password",
      "password": true
    },
    {
      "type": "promptString",
      "id": "gemini-key",
      "description": "Gemini API Key",
      "password": true
    },
    {
      "type": "promptString",
      "id": "gcs-credentials",
      "description": "Google Cloud Service Account JSON",
      "password": true
    }
  ],
  "servers": {
    "imap-mcp": {
      "type": "stdio",
      "command": "${userHome}/git/imap-mcp-server/venv/bin/python",
      "args": [
        "${userHome}/git/imap-mcp-server/src/server.py"
      ],
      "env": {
        "GEMINI_API_KEY": "${input:gemini-key}",
        "IMAP_HOST": "imap.gmail.com",
        "ANALYTICS_BATCH_SIZE": "50",
        "ANALYTICS_CACHE_DURATION": "60",
        "ANALYTICS_THREAD_ANALYSIS": "true",
        "ANALYTICS_PRIORITY_SCORING": "true",
        "GCS_BUCKET": "imap-mcp-server",
        "ANALYTICS_SENDER_THRESHOLD": "7",
        "ANALYTICS_DOMAIN_THRESHOLD": "10",
        "ANALYTICS_UPDATE_INTERVAL": "3600",
        "ANALYTICS_LABEL_TRACKING": "true",
        "ANALYTICS_TYPE_CLASSIFICATION": "true",
        "LOG_LEVEL": "ERROR"
      }
    }
  }
}

配置选项

• 环境变量：
  • GEMINI_API_KEY：用于 AI 驱动分析的 Gemini API 密钥
  • IMAP_HOST：Gmail IMAP 服务（默认值：imap.gmail.com）
  • ANALYTICS_BATCH_SIZE：每批处理的邮件数量（默认值：50）
  • ANALYTICS_CACHE_DURATION：缓存时长，单位为分钟（默认值：60）
  • ANALYTICS_THREAD_ANALYSIS：启用邮件线程分析（默认值：true）
  • ANALYTICS_PRIORITY_SCORING：启用邮件优先级评分（默认值：true）
  • GCS_BUCKET：用于存储邮件的 Google Cloud Storage 存储桶名称
  • ANALYTICS_SENDER_THRESHOLD：触发分析所需的发件人邮件数量下限（默认值：7）
  • ANALYTICS_DOMAIN_THRESHOLD：触发分析所需的域名邮件数量下限（默认值：10）
  • ANALYTICS_UPDATE_INTERVAL：分析更新间隔，单位为秒（默认值：3600）
  • ANALYTICS_LABEL_TRACKING：启用标签跟踪（默认值：true）
  • ANALYTICS_TYPE_CLASSIFICATION：启用邮件类型分类（默认值：true）
  • LOG_LEVEL：日志级别（默认值：ERROR）

前提条件

使用此服务前：

1. 在项目目录中创建 Python 虚拟环境
2. 使用 pip install -r requirements.txt 安装所需依赖项
3. 按照上文所示配置 VS Code 设置
4. 确保你拥有以下有效凭据：
   • Gmail 账户（用户名和密码）
   • Gemini API 密钥
   • Google Cloud 服务账户（用于 GCS 集成）

要求

• 已启用 API 访问权限的 Gmail 账户。
• 用于访问 Gmail API 和 Google Cloud Storage 的 Google Cloud 凭据。
• Python 3.8 或更高版本。

工具

gmail-mcp-server 提供以下工具，用于管理和分析 Gmail 账户：

test_connection

• 描述：使用 OAuth2 凭据测试 Gmail API 连接。
• 返回：连接成功时返回 Gmail 标签列表。

list_labels

• 描述：列出 Gmail 账户中的所有可用标签。
• 返回：包含标签名称和 ID 的字典。

search_emails

• 描述：使用 IMAP 搜索条件搜索 Gmail 邮件。
• 参数：
  • mailbox：要搜索的 Gmail 标签（例如，“INBOX”）。
  • criteria：IMAP 搜索条件（例如，“ALL”）。
  • limit：要返回的邮件数量上限。
• 返回：符合条件的 Gmail 邮件列表。

get_email

• 描述：根据邮件 ID 获取邮件的完整内容。
• 参数：
  • mailbox：包含该邮件的 Gmail 标签。
  • message_id：邮件的唯一标识符。
• 返回：邮件内容和元数据。

analyze_inbox

• 描述：分析邮件模式，并提供 Gmail 收件箱洞察。
• 参数：
  • days：要分析的天数（默认值：7）。
• 返回：邮件活动、发件人模式等方面的洞察。

get_total_messages

• 描述：获取收件箱中的邮件总数。
• 返回：邮件总数。

analyze_inbox_state

• 描述：全面分析收件箱状态。
• 参数：
  • max_messages：要分析的邮件数量上限（默认值：100）。
• 返回：分析结果，包括发件人活动、邮件类型和附件统计信息。

move_message

• 描述：将邮件从一个文件夹移至另一个文件夹。
• 参数：
  • uid：邮件的唯一标识符。
  • from_folder：包含该邮件的源文件夹。
  • to_folder：要将邮件移至的目标文件夹。
• 返回：操作的成功状态。

create_smart_folder

• 描述：根据指定的筛选规则创建智能文件夹。
• 参数：
  • name：智能文件夹的名称。
  • rules：该文件夹的筛选规则列表。
• 返回：已创建智能文件夹的详细信息。

batch_process

• 描述：根据条件批量处理多封邮件。
• 参数：
  • folder：要从中处理邮件的文件夹。
  • action：要执行的操作（例如，“move”“delete”或“label”）。
  • filter_criteria：用于筛选邮件的条件。
• 返回：批量操作的结果。

migrate_email_to_gcs

• 描述：将邮件迁移至 Google Cloud Storage。
• 参数：
  • uid：邮件的唯一标识符。
  • folder：包含该邮件的文件夹。
  • gcs_prefix：用于存储邮件的 GCS 文件夹。
• 返回：已存储邮件数据和附件的路径。

get_folder_summary

• 描述：获取文件夹的汇总统计信息。
• 参数：
  • folder：要获取汇总统计信息的文件夹。
• 返回：汇总统计信息，包括邮件数量和活动趋势。

search_messages

• 描述：使用 Gmail 的搜索语法搜索 Gmail 邮件。
• 参数：
  • query：Gmail 搜索查询（例如，“from:[email protected] has:attachment”）。
  • max_results：要返回的邮件数量上限。
• 返回：匹配的 Gmail 邮件列表。

get_thread

• 描述：获取 Gmail 会话中的所有邮件。
• 参数：
  • thread_id：要获取的会话 ID。
• 返回：该会话及其中的邮件。

get_messages

• 描述：获取 Gmail 邮件，可选择按标签筛选。
• 参数：
  • label_ids：可选的 Gmail 标签 ID 列表，用于筛选邮件。
  • max_results：要返回的邮件数量上限。
• 返回：Gmail 邮件列表。

入门

1. 设置 Gmail API 凭据。
2. 使用 Gmail 专属设置配置服务。
3. 运行服务，开始管理和分析 Gmail 收件箱。

如需详细的设置说明，请参阅 设置指南。