JinDaGe - GongRzhe_Gmail-MCP-Server MCP Details

article

README

🚀 Gmail 自动身份验证 MCP 服务器

本项目是一个用于 Gmail 集成的 Claude 桌面版的 Model Context Protocol (MCP) 服务器，支持自动身份验证功能。借助此服务器，AI 助手能够通过自然语言交互管理 Gmail，为用户提供便捷的邮件管理体验。

🚀 快速开始

本服务器可助力 AI 助手通过自然语言交互管理 Gmail。下面将为您详细介绍如何快速开启使用之旅。

✨ 主要特性

丰富的邮件操作：支持发送带有主题、内容、附件和收件人的电子邮件；可通过 ID 阅读电子邮件消息；能使用各种标准（主题、发件人、日期范围）搜索电子邮件；可在收件箱、已发送或自定义标签中列出电子邮件；还能标记电子邮件为已读/未读，以及将电子邮件移动到不同的标签/文件夹。
深度集成：与 Gmail API 完全集成，确保功能的全面性和稳定性。
便捷的身份验证：采用简单的 OAuth2 身份验证流程，支持自动浏览器启动，方便快捷。
多平台支持：支持桌面版和网络版，满足不同用户的使用需求。
安全存储：在本地安全存储凭据，保障用户信息安全。

📦 安装指南

使用 Smithery CLI 安装

smith install @gongrzhe/server-gmail-autoauth-mcp

手动安装

克隆此仓库：

git clone https://github.com/yourusername/gmail-autoauth-mcp.git
cd gmail-autoauth-mcp

安装依赖项：
```
npm install
```
启动服务器：
```
node index.js
```

💻 使用示例

基础用法

发送电子邮件

{
  "to": ["recipient@example.com"],
  "subject": "Meeting Tomorrow",
  "body": "Hi,\n\nJust a reminder about our meeting tomorrow at 10 AM.\n\nBest regards",
  "cc": ["cc@example.com"],
  "bcc": ["bcc@example.com"]
}

搜索电子邮件

{
  "query": "from:sender@example.com after:2024/01/01",
  "maxResults": 10
}

阅读电子邮件

{
  "messageId": "message123"
}

移动电子邮件

{
  "messageId": "message123",
  "labelIds": ["INBOX", "IMPORTANT"]
}

📚 详细文档

配置 Gmail 凭据

在 config.json 文件中添加以下内容：

{
  "gmail": {
    "clientId": "your_client_id",
    "clientSecret": "your_client_secret",
    "redirectUri": "http://localhost:3000"
  }
}

授权 Gmail 帐户

运行以下命令以授权您的 Gmail 帐户：

node authorize.js

按照提示完成 OAuth 流程。

🔧 技术细节

安全注意事项

凭据存储：OAuth 凭据安全存储在本地环境 (~/.gmail-mcp)。
持久验证：服务器使用离线访问来保持持久身份验证。
隐私保护：绝对不要共享或提交您的凭据到版本控制；定期检查并吊销未使用的 Google 账户权限；凭据在全球范围内存储，但仅限当前用户访问。

故障排除

OAuth Keys 未找到
- 确保 gcp-oauth.keys.json 在当前目录或 ~/.gmail-mcp/ 中。
- 检查文件权限。
无效凭据格式
- 确保您的 OAuth 凭据文件包含 web 或 installed 凭据。
- 对于网络应用，请验证重定向 URI 正确配置。
端口已被占用
- 如果端口 3000 已被占用，请释放它。
- 您可以找到并停止使用该端口的进程。

📄 许可证

本项目根据 ISC 许可证发布。

👋 支持与贡献

贡献

欢迎贡献！请随时提交 Pull Request。

支持

如果您遇到任何问题或有任何疑问，请在 GitHub 仓库中提交问题。

GongRzhe_Gmail-MCP-Server