README
🚀 Gmail MCP 服务器
本项目是一个基于 Spring Boot 的 Gmail MCP(模型上下文协议)服务器,提供了与 Gmail 交互的各类工具,通过 GMailer 类实现。同时,项目包含客户端 ClientStdio,可用于测试 MCP 服务器功能。
✨ 主要特性
-
GMailer 工具:
trashEmail:依据邮件 ID 将邮件移至垃圾箱。markEmailAsRead:根据邮件 ID 标记邮件为已读。sendEmail:向指定收件人发送邮件。getUnreadMessages:获取未读邮件。readEmail:根据邮件 ID 读取邮件。
-
ClientStdio:这是一个用于测试 MCP 服务器功能的客户端,通过标准输入输出进行交互。
📦 安装指南
先决条件
- Java 17 或更高版本
- Maven
- Gmail API 凭证
设置步骤
- 克隆仓库:
git clone <repository-url>
cd <repository-directory>
-
配置 Gmail API 凭证:
- 创建新的 Google Cloud 项目
- 启用 Gmail API
- 配置 OAuth 一致性屏幕
- 选择 "外部"。不过,我们不会发布此应用程序。
- 添加您的个人电子邮件地址作为 "测试用户"。
- 添加 OAuth 范围
https://www.googleapis.com/auth/gmail/modify - 为应用创建 OAuth 客户端 ID,选择应用类型 "桌面应用程序"
- 下载您的客户 OAuth 密钥的 JSON 文件
- 将文件重命名为
credentials.json并保存到本地计算机的安全位置。请记住该位置。 - 将
credentials.json文件放在项目的src/main/resources目录中。
-
构建项目:
mvn clean install
🚀 快速开始
运行 MCP 服务器
要启动 MCP 服务器,请运行以下命令:
mvn spring-boot:run
使用 ClientStdio 测试
ClientStdio 类可用于测试 MCP 服务器的功能,它通过标准输入输出与服务器交互。
首先使用以下命令构建项目:
mvn clean install -DskipTests
然后运行 ClientStdio 类。
📄 许可证
该项目根据 MIT License 授权。有关详细信息,请参阅 LICENSE 文件。
Scan to join WeChat group