🚀 Gmail 服务器用于模型上下文协议（MCP）

本 MCP 服务器与 Gmail 深度集成，为用户提供了强大且便捷的电子邮件管理功能，涵盖发送、删除、阅读、撰写和回复等操作。

⚠️ 重要提示

此服务器允许 MCP 客户端读取、删除和发送电子邮件。不过，客户端会在执行此类操作之前提示用户。

GitHub 资源链接

🚀 快速开始

按照以下步骤，您可以轻松将 Gmail MCP 服务器集成到您的应用中。

✨ 主要特性

• 多功能集成：支持发送、删除、阅读、撰写和回复电子邮件等常见操作。
• 用户友好：客户端在执行敏感操作前会提示用户，保障用户信息安全。

📦 安装指南

安装依赖

使用 pip 安装所需的库（如 google-api-python-client 等）。

配置环境变量

设置 Google API 准入信息，包括客户端 ID 和客户端密钥。

启动服务器

使用提供的命令启动服务器，并指定 --creds-file-path 和 access-tokens-file 的路径。

💻 使用示例

基础用法

以下是使用各个工具的示例：

# 发送邮件
# 假设已经完成认证和环境配置
from your_module import send_email
recipient_id = "example@example.com"
subject = "Test Email"
message = "This is a test message."
status, message_id = send_email(recipient_id, subject, message)

# 将邮件移到垃圾箱
from your_module import trash_email
email_id = "1234567890"
success_message = trash_email(email_id)

# 标记邮件为已读
from your_module import mark_email_as_read
email_id = "1234567890"
success_message = mark_email_as_read(email_id)

# 检索未读邮件
from your_module import get_unread_emails
unread_emails = get_unread_emails()

# 检索指定邮件内容
from your_module import read_email
email_id = "1234567890"
email_metadata = read_email(email_id)

# 在浏览器中打开邮件
from your_module import open_email
email_id = "1234567890"
success_message = open_email(email_id)

📚 详细文档

组件

工具

• 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。
  • 返回值：成功消息并打开指定电子邮件在默认浏览器中。

设置

Gmail API 配置

1. 创建新的 Google Cloud 项目
2. 启用 Gmail API
3. 配置 OAuth 一致性屏幕
   • 选择“外部”。不过，我们不会发布此应用程序。
   • 将您的个人电子邮件地址添加为“测试用户”。
4. 添加 OAuth 范围 https://www.googleapis.com/auth/gmail/modify
5. 创建应用类型的 OAuth 客户端 ID，选择“桌面应用程序”
6. 下载您的客户端的 OAuth 密钥文件 JSON 文件
7. 重命名密钥文件并保存到本地计算机的安全位置。记住该位置。
   • 启动服务器时，将通过参数 --creds-file-path 传递此文件的绝对路径。

认证

启动服务器时，认证流程将在您的系统浏览器中自动启动。

• 按照屏幕上的指示授予权限即可完成设置。

🔧 技术细节

本服务器通过与 Gmail API 交互实现各项功能。在启动服务器时，会通过指定的 --creds-file-path 参数加载 OAuth 密钥文件，完成认证流程后，即可调用 Gmail API 进行邮件的管理操作。

📄 故障排除

• 如果遇到问题，请检查以下内容：
  • 确保 Google API 项目已正确配置。
  • 确保 OAuth 流程已完成且没有错误。
  • 检查日志以获取更多信息。

通过以上步骤，您可以成功设置 Gmail MCP 服务器并集成到您的应用中！