JinDaGe - Gmail MCP Details

article

README

🚀 Gmail MCP 服务器

Gmail MCP 服务器是一个基于模型上下文协议（Model Context Protocol）的服务器，它能够为像 Claude Desktop 这样的 MCP 客户端提供 Gmail 集成功能，让用户可以方便地在客户端中使用 Gmail 的相关服务。

🚀 快速开始

Gmail MCP 服务器为 MCP 客户端提供了 Gmail 集成功能。以下是快速开始使用该服务器的步骤：

完成 Google Cloud 项目设置。
进行服务器的安装。
配置用于 Claude Desktop。
首次运行并完成授权。

✨ 主要特性

邮件查看：可查看 Gmail 收件箱中的最近邮件。
邮件搜索：支持使用 Gmail 的搜索语法搜索邮件。
安全认证：通过 OAuth2 进行安全的身份验证与 Gmail API。

📦 安装指南

1. Google Cloud 项目设置

在 Google Cloud 控制台创建一个 Google Cloud 项目。
启用 Gmail API。
创建 OAuth 2.0 凭证：
- 应用类型：桌面应用
- 将凭证下载为 credentials.json

2. 安装依赖

# 创建一个 conda 环境
conda create -n mcp-gmail python=3.12
conda activate mcp-gmail

# 安装包
cd gmail-mcp-server
pip install -e .

3. 配置用于 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"
      }
    }
  }
}

请将 /path/to/ 替换为您的实际路径。首次认证时，令牌文件会自动创建。

4. 首次运行

当您第一次尝试通过 Claude 访问 Gmail 时，将在浏览器中提示您授权应用程序。授权后，凭证将保存到令牌文件中以供以后使用。

💻 使用示例

可用资源

gmail://inbox/recent - 返回您的 10 封最新邮件

可用工具

search_emails
- 描述：使用查询搜索 Gmail 邮件
- 参数：
  - query（必需）：Gmail 搜索查询（使用 Gmail 的标准搜索语法）
  - max_results（可选）：要返回的结果的最大数量（默认值：10）

示例搜索：

你能展示我过去两天内来自 sanrio 的任何邮件吗？

📚 详细文档

安全说明

此服务器需要通过 OAuth2 进行身份验证与 Gmail：

第一次使用时，您会在浏览器中被提示授权访问。
凭证会本地保存在指定的令牌文件中。
可以随时通过您的 Google 账户设置 revoke 授权。
仅请求对 Gmail 的读取权限（无写入权限）。

环境变量

GMAIL_CREDENTIALS_FILE（必需）：Google OAuth 凭证文件的路径。
GMAIL_TOKEN_FILE（必需）：令牌保存位置的路径。

为了测试，可以直接运行服务器：

GMAIL_CREDENTIALS_FILE="/path/to/credentials.json" \
GMAIL_TOKEN_FILE="/path/to/token.json" \
python -m gmail_mcp_server.server

开发说明

该服务器使用 Model Context Protocol 提供以下功能：

资源访问以获取最新邮件。
邮件搜索工具支持。
权限管理与日志记录。
可扩展的事件处理机制。

贡献指南

如果您希望为项目做出贡献，请遵循以下指南：

创建一个分支用于您的新功能或修复。
提交您的更改并添加适当的提交信息，解释所做的修改。
提交 pull request 到主要仓库，并在问题跟踪系统中引用相关的 issue。

请确保您的代码符合项目的编码规范，并通过现有的测试套件。

Gmail