README
🚀 MCP Gmail 服务器
MCP Gmail 服务器是一个基于 Model Context Protocol (MCP) 的服务器,它借助 MCP Python SDK 实现了对 Gmail 的便捷访问。通过该服务器,用户能够以 MCP 资源的形式操作 Gmail 邮件,还能使用一系列工具来创建、发送、搜索邮件等。
✨ 主要特性
- 资源暴露:将 Gmail 消息作为 MCP 资源暴露,方便用户统一管理和操作。
- 邮件工具丰富:提供了
compose_email、send_email、search_emails等多种工具,涵盖了邮件的创建、发送、搜索等常见操作。 - 标签管理:支持对邮件标签的操作,如
list_available_labels、add_label_to_message、remove_label_from_message等。
📦 安装指南
第一步:安装依赖项
使用 uv 命令同步项目并安装所有必要的依赖项:
uv sync
第二步:配置 OAuth 凭证
- 打开 Google Cloud Console 并创建一个新的项目。
- 启用 Gmail API。
- 进入 OAuth 界面设置部分,填写应用信息和权限范围。
- 创建 OAuth 客户端 ID 并下载
credentials.json文件。
第三步:验证配置
运行以下命令以确保配置正确:
python test_script.py
🚀 快速开始
启动服务器
- 开发模式:在开发模式下启动服务器,使用以下命令:
uv run server.py
- 安装到 Claude Desktop:配置
command属性为正确的 uv 可执行文件路径,并设置环境变量指向credentials.json和token.json文件。
环境变量配置
项目可以通过以下环境变量进行配置:
| 属性 | 详情 |
|------|------|
| MCP_GMAIL_CREDENTIALS_PATH | 指定 OAuth 凭证 JSON 文件的路径(默认值:credentials.json) |
| MCP_GMAIL_TOKEN_PATH | 指定存储 OAuth 令牌文件的路径(默认值:token.json) |
| MCP_GAIL_MAX_RESULTS | 默认搜索查询结果的最大数量(默认值:10) |
💻 使用示例
可用资源
gmail://messages/{message_id}: 访问单个邮件消息gmail://threads/{thread_id}: 访问邮件主题
可用工具
compose_email: 创建新邮件草稿send_email: 发送邮件search_emails: 根据发件人、收件人或主题搜索邮件query_emails: 使用原始 Gmail 查询语法搜索邮件get_emails: 按 ID 获取多个邮件消息list_available_labels: 获取所有可用的 Gmail 标签mark_message_read: 标记消息为已读add_label_to_message: 向消息添加标签remove_label_from_message: 从消息移除标签
📄 许可证
本项目采用 MIT 许可证。
Scan to contact