🚀 Gmail 服务器用于模型上下文协议（MCP）
本 MCP 服务器与 Gmail 集成，可实现发送、删除、读取、草拟和回复电子邮件等功能，为用户提供便捷的邮件操作体验。
⚠️ 重要提示
此服务器使 MCP 客户端能够读取、删除和发送电子邮件。但是，客户端会在执行此类活动之前提示用户。
🚀 快速开始
本 MCP 服务器与 Gmail 集成，可实现发送、删除、读取、草拟和回复电子邮件等功能。以下将详细介绍其组件、安装步骤及使用方法。
✨ 主要特性
- 与 Gmail 集成，实现多种邮件操作功能。
- 客户端在执行敏感操作前会提示用户，保障用户信息安全。
📦 安装指南
Gmail API 设置
- 创建新的 Google Cloud 项目
- 启用 Gmail API
- 配置 OAuth 同意屏幕
- 选择“外部”。但是，我们不会发布此应用程序。
- 将您的个人电子邮件地址添加为“测试用户”。
- 添加 OAuth 范围
https://www.googleapis.com/auth/gmail/modify - 创建应用类型的 OAuth 客户 ID（例如“桌面应用程序”）
- 下载您的客户的 OAuth 密钥 JSON 文件
- 重命名密钥文件并保存到本地计算机的安全位置。注意该文件的位置。
- 启动服务器时，将作为参数传递的绝对路径
--creds-file-path。
- 启动服务器时，将作为参数传递的绝对路径
身份验证
当服务器启动时，身份验证流程将在您的系统浏览器中启动。凭据令牌随后保存（并在稍后检索）到指定的绝对文件路径，该路径通过参数 --token-path 传递。
例如，您可以使用主目录中的点目录：
| 参数 | 示例 |
|---|---|
--creds-file-path |
/[your-home-folder]/.google/client_creds.json |
--token-path |
/[your-home-folder]/.google/token.json |
使用说明
要启动服务器，请运行命令：
python3 src/main.py --config config.yaml
验证
要验证服务器是否正常运行，可以执行以下步骤：
- 发送测试电子邮件。
- 检查收件箱以确认电子邮件已送达。
问题排查
如果遇到任何问题，请检查以下内容：
- 确保 Gmail API 已正确启用
- 验证 OAuth 资格凭证是否有效
- 检查日志文件以获取更多信息
📚 详细文档
组件
工具
-
send-email
- 功能：向收件人地址发送电子邮件
- 输入：
recipient_id(字符串)：收件人的电子邮件地址subject(字符串)：邮件主题message(字符串)：邮件内容
- 返回：状态和消息 ID
-
trash-email
- 功能：将电子邮件移到垃圾箱
- 输入：
email_id(字符串)：自动生成的电子邮件 ID
- 返回：成功消息
-
mark-email-as-read
- 功能：标记电子邮件为已读
- 输入：
email_id(字符串)：自动生成的电子邮件 ID
- 返回：成功消息
-
get-unread-emails
- 功能：检索未读电子邮件
- 返回：电子邮件列表，包括电子邮件 ID
-
read-email
- 功能：检索给定电子邮件的内容
- 输入：
email_id(字符串)：自动生成的电子邮件 ID
- 返回：电子邮件元数据字典并标记电子邮件为已读
-
open-email
- 功能：在浏览器中打开电子邮件
- 输入：
email_id(字符串)：自动生成的电子邮件 ID
- 返回：成功消息并在默认浏览器中打开指定电子邮件
📄 许可证
版本 1.0.0 - 初始发布