JinDaGe - gmail-mcp-server-njw MCP Details

article

README

🚀 Gmail MCP 服务器

这个 MCP 服务器借助 Model Context Protocol 提供对 Gmail 功能的访问，允许像 Claude 这样的大语言模型与您的电子邮件进行交互，为大语言模型与邮件系统的交互提供了便捷途径。

✨ 主要特性

列出收件箱中的邮件
搜索特定邮件
查看邮件内容
发送新邮件
回复现有邮件

📦 安装指南

安装依赖项：

python -m venv venv
source venv/bin/activate  # 在 Windows 上：venv\Scripts\activate
pip install -r requirements.txt

设置 Google API 凭据：
- 访问 Google Cloud Console
- 创建新项目
- 启用 Gmail API：
  - 在侧边栏中，导航到 "APIs & Services" > "Library"
  - 搜索 "Gmail API" 并选择它
  - 点击 "Enable"
- 创建 OAuth 2.0 凭据：
  - 在侧边栏中，导航到 "APIs & Services" > "Credentials"
  - 点击 "Create Credentials" 并选择 "OAuth client ID"
  - 选择 "Desktop application" 作为应用类型
  - 输入一个名称为您的 OAuth 客户（例如，"Gmail MCP Server"）
  - 点击 "Create"
  - 下载凭据 JSON 文件并将其保存为 credentials.json 在项目根目录中
复制示例创建 .env 文件：
```
cp .env.example .env
```
运行服务器：
- 第一次运行服务器时，它会打开一个浏览器窗口进行身份验证
- 跟随提示完成授权流程以允许应用程序访问您的 Gmail 帐户

📚 详细文档

详细 Gmail API 设置

理解凭据文件

credentials.json：

此文件包含您从 Google Cloud 获取的 OAuth 2.0 客户端凭据
用于标识您的应用到 Google 的 OAuth 服务器

格式示例（值将根据您的应用程序不同）：

{
  "installed": {
    "client_id": "YOUR_CLIENT_ID.apps.googleusercontent.com",
    "project_id": "your-project-id",
    "auth_uri": "https://accounts.google.com/o/oauth2/auth",
    "token_uri": "https://oauth2.googleapis.com/token",
    "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
    "client_secret": "YOUR_CLIENT_SECRET",
    "redirect_uris": ["http://localhost"]
  }
}

您可以使用提供的 credentials.json.example 作为参考

token.json：

此文件在第一次身份验证时自动生成
它包含访问您的 Gmail 帐户所需的 OAuth 令牌
文件在您完成浏览器中的身份验证流程后创建

格式示例（令牌将根据您的帐户不同）：

{
  "token": "ya29.a0AfB_byC...",
  "refresh_token": "1//0eXxYz...",
  "token_uri": "https://oauth2.googleapis.com/token",
  "client_id": "YOUR_CLIENT_ID.apps.googleusercontent.com",
  "client_secret": "YOUR_CLIENT_SECRET",
  "refresh_token": "1//0eXxYz...",
  "expiry_time": "2023-10-25T12:36:48.000Z"
}

🔧 技术细节

这个项目遵循简洁、高效的设计理念：

最小化代码，无冗余
直接集成 Gmail API
无模拟数据或不必要的抽象
关注可靠性和性能

gmail-mcp-server-njw