README
🚀 Gmail 插件 MCP 服务器
这是一个强大的 MCP 服务器,支持与 Gmail 集成。借助它,你能通过 MCP 客户端直接管理电子邮件,无缝访问 Gmail 的核心功能,如阅读、发送和管理邮件等。
💡 参考:查看 这个示例 了解使用 uvx 的 MCP 服务器实现示例。
🚀 快速开始
先决条件
- Python 3.12 或更高版本
- Gmail API 凭证
- MCP 客户端(如 Claude Desktop)
安装
- 克隆仓库:
git clone https://github.com/yourusername/gmail-plugin.git
cd gmail-plugin
- 安装依赖项(选择一种方法):
# 方法 1: 在编辑模式下安装
uv pip install -e .
# 方法 2: 使用 requirements.txt 安装
uv pip install -r requirements.txt
# 方法 3: 推荐使用 uv sync
uv sync --dev --all-extras
- 配置 Gmail API 凭证:
- 访问 Google Cloud Console
- 创建新项目或选择现有项目
- 启用 Gmail API
- 配置 OAuth 一致性屏幕:
- 选择“外部”用户类型(无需发布)
- 转到受众群体标签:添加您的电子邮件作为“测试用户”
- 添加 OAuth 作用域:
https://www.googleapis.com/auth/gmail/modify
- 创建 OAuth 2.0 凭证:
- 选择“桌面应用”作为应用程序类型
- 下载 JSON 凭证文件
- 保存凭证文件并记下其绝对路径(将用于
--creds-file-path)
配置
开发/未发布的服务器
在您的 MCP 客户端配置中添加以下内容:
# 方法 1: 在编辑模式下安装
uv pip install -e .
# 方法 2: 使用 requirements.txt 安装
uv pip install -r requirements.txt
# 方法 3: 推荐使用 uv sync
uv sync --dev --all-extras
发布的服务器
在 app.py 中添加以下内容:
if __name__ == "__main__":
app.run(debug=True)
✨ 主要特性
- 📧 发送和接收电子邮件
- 📥 阅读未读消息
- 🗑️ 删除电子邮件
- 📱 在浏览器中打开电子邮件
- 📝 标记电子邮件为已读
- 🔒 使用 OAuth2 进行身份验证
🎥 演示
📦 安装指南
克隆仓库
git clone https://github.com/yourusername/gmail-plugin.git
cd gmail-plugin
安装依赖
# 方法 1: 在编辑模式下安装
uv pip install -e .
# 方法 2: 使用 requirements.txt 安装
uv pip install -r requirements.txt
# 方法 3: 推荐使用 uv sync
uv sync --dev --all-extras
配置凭证
- 访问 Google Cloud Console
- 创建新项目或选择现有项目
- 启用 Gmail API
- 配置 OAuth 一致性屏幕:
- 选择“外部”用户类型(无需发布)
- 转到受众群体标签:添加您的电子邮件作为“测试用户”
- 添加 OAuth 作用域:
https://www.googleapis.com/auth/gmail/modify
- 创建 OAuth 2.0 凭证:
- 选择“桌面应用”作为应用程序类型
- 下载 JSON 凭证文件
- 保存凭证文件并记下其绝对路径(将用于
--creds-file-path)
💻 使用示例
基础用法
在 app.py 中:
@app.route('/')
def home():
return "欢迎使用 Gmail 插件 MCP 服务器!"
📚 详细文档
API 参考
工具
| 属性 | 详情 | | ---- | ---- | | 工具名称 | 描述 | | send_email | 发送电子邮件,参数:recipient_id, subject, message | | read_email | 阅读未读邮件 | | delete_email | 删除电子邮件,参数:email_id | | mark_read | 标记为已读,参数:email_id |
🤝 贡献
- fork 项目仓库。
- 创建功能分支:
git checkout -b feature/your-feature - 提交更改:
git commit -m '添加新功能' - 推送到 fork:
git push origin feature/your-feature - 创建拉取请求。
📄 许可证
本项目受 MIT License 保护。
Scan to contact