Back to MCP directory
publicPublicdnsLocal runtime

gmail-mcp-server-yv2

该项目是一个Gmail邮件服务的MCP服务器,提供发送、删除、阅读、草拟和回复邮件功能,需通过Gmail API授权使用。

article

README

🚀 Gmail 服务器用于模型上下文协议(MCP)

本 MCP 服务器与 Gmail 集成,可实现发送、删除、阅读、撰写和回复电子邮件等功能,为邮件管理提供了便捷的解决方案。

⚠️ 重要提示

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

GitHub 资源链接

✨ 主要特性

该 MCP 服务器具备多种实用工具,可对电子邮件进行多样化操作:

  • send-email:能将邮件发送到指定收件人地址。输入参数包括 recipient_id(收件人电子邮件地址)、subject(邮件主题)和 message(邮件内容),操作完成后返回状态和消息 ID。
  • trash-email:可将指定 email_id 的电子邮件移到垃圾箱,并返回成功消息。
  • mark-email-as-read:把指定 email_id 的电子邮件标记为已读,返回成功消息。
  • get-unread-emails:检索未读电子邮件,返回包含电子邮件 ID 的未读邮件列表。
  • read-email:检索指定 email_id 电子邮件的内容,返回包含电子邮件元数据的字典,并将该邮件标记为已读。
  • open-email:在默认浏览器中打开指定 email_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 传递此文件的绝对路径。

认证

启动服务器时,认证流程将在系统浏览器中自动启动。只需按照屏幕上的指示授予权限,即可完成设置。

💻 使用示例

基础用法

  1. 安装必要的依赖项:
pip install google-api-python-client  # 安装所需的库
  1. 配置环境变量:设置 Google API 准入信息,包括客户端 ID 和客户端密钥。
  2. 启动服务器:使用提供的命令启动服务器,并指定 crets-file-pathaccess-tokens-file 的路径。

📚 详细文档

工具参数详情

| 工具 | 功能 | 输入参数 | 返回值 | | ---- | ---- | ---- | ---- | | 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 | 成功消息并在默认浏览器中打开邮件 |

🔧 技术细节

故障排除

若在使用过程中遇到问题,请检查以下内容:

  • 确保 Google API 项目已正确配置。
  • 确保 OAuth 流程已完成且没有错误。
  • 检查日志以获取更多信息。

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

help

Runtime guide

cloud

Hosted runtime

Hosted servers run from a provider-managed environment. You usually connect the MCP client to the hosted endpoint or follow the provider's authorization flow, without keeping a local process alive

  1. Open provider connection page
  2. Authorize or copy endpoint
  3. Connect from your MCP client
terminal

Local runtime / other methods

Local servers run on your own machine or infrastructure. You normally copy the server_config into your MCP client, install the required package, and provide env variables from env_schema when needed

  1. Copy server_config
  2. Install required package
  3. Fill env variables and restart client