使用说明

项目简介

本项目是一个基于 Model Context Protocol (MCP) 构建的 Gmail 服务器，旨在为大型语言模型 (LLM) 客户端（如 Claude Desktop）提供 Gmail 集成能力。通过此服务器，LLM 可以安全地访问您的 Gmail 邮箱，实现查看最新邮件、搜索邮件以及发送邮件等功能。

主要功能点

查看最新邮件: 允许 LLM 获取您 Gmail 收件箱中的最新邮件。
邮件搜索: 支持使用 Gmail 的搜索语法来检索特定的邮件。
发送邮件: 允许 LLM 通过您的 Gmail 账户发送电子邮件。
OAuth2 认证: 采用安全的 OAuth2 认证方式访问 Gmail API，保障您的账户安全。

安装步骤

Google Cloud 项目配置
- 访问 Google Cloud Console 创建一个新的 Google Cloud 项目。
- 在项目中启用 Gmail API。
- 创建 OAuth 2.0 凭据：
  - 应用类型选择“桌面应用”。
  - 下载凭据文件并保存为 'credentials.json'。

安装服务器

确保已安装 conda。

创建 conda 虚拟环境：

conda create -n mcp-gmail python=3.12

激活虚拟环境：

conda activate mcp-gmail

进入 'gmail-mcp-server' 仓库目录。
安装服务器程序：
```
pip install -e .
```

服务器配置

要将此 MCP 服务器配置到您的 MCP 客户端（例如 Claude Desktop），您需要在客户端的配置文件（如 'claude_desktop_config.json'）中添加以下服务器配置信息。以下是一个配置示例，您需要根据实际路径进行修改：

{
  "mcpServers": {
    "gmail": {
      "command": "/path/to/conda/envs/mcp-gmail/bin/python",
      "args": ["-m", "gmail_mcp_server.server"],
      "env": {
        "PYTHONPATH": "/path/to/gmail-mcp-server/src",
        "GMAIL_CREDENTIALS_FILE": "/path/to/credentials.json",
        "GMAIL_TOKEN_FILE": "/path/to/token.json"
      }
    }
  }
}

配置参数说明:

'"gmail"': 服务器名称，您可以自定义，用于在 MCP 客户端中标识此服务器。
'"command"': 启动服务器的命令，指向您 conda 环境中的 Python 可执行文件。
'"args"': 传递给启动命令的参数，指定运行 'gmail_mcp_server.server' 模块。
'"env"': 环境变量配置：
- '"PYTHONPATH"': 指向 'gmail-mcp-server' 仓库 'src' 目录的路径，用于 Python 导入模块。
- '"GMAIL_CREDENTIALS_FILE"': 指向您下载的 'credentials.json' 凭据文件的路径。
- '"GMAIL_TOKEN_FILE"': 指定用于保存认证 token 文件的路径，该文件将由服务器自动创建。

请务必将 '/path/to/' 替换为您的实际路径。

基本使用方法

启动 MCP 服务器：在您的 MCP 客户端中启动配置好的 "gmail" 服务器。客户端会根据您提供的 'command' 和 'args' 运行服务器。
首次授权：当 LLM 客户端首次尝试访问 Gmail 资源或工具时，您将被引导至浏览器进行 OAuth2 授权。按照页面提示完成授权流程。
使用 Gmail 功能：授权成功后，您的 LLM 客户端即可使用 'gmail://inbox/recent' 资源访问最新邮件，并调用 'search_emails' 和 'send_email' 工具与 Gmail 邮箱进行交互。

关键词