Gmail MCP Server 使用说明

项目简介

Gmail MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 AI 助手提供与 Gmail 和 Google 日历集成的能力。通过此服务器，AI 模型可以安全、标准地访问和操作用户的 Gmail 邮箱和 Google 日历，实现邮件的读取、发送、草稿管理以及日历事件的查询和创建等功能。

主要功能点

邮件操作:
- 列出邮件 (listEmails)：支持高级过滤条件，如查询关键词、标签等。
- 读取邮件 (readEmail)：获取邮件的完整内容。
- 发送邮件 (sendEmail)：创建并发送新邮件，或发送已存在的草稿邮件。
草稿管理:
- 创建草稿 (draftEmail)：创建新的邮件草稿。
- 列出草稿 (listDrafts)：查看现有的邮件草稿列表。
- 读取草稿 (readDraft)：获取草稿的详细内容。
- 更新草稿 (updateDraft)：修改草稿的内容和收件人等信息。
- 删除草稿 (deleteDraft)：删除指定的邮件草稿。
日历操作:
- 列出日历事件 (listEvents)：查询即将到来的日历事件，支持时间范围、关键词过滤。
- 读取日历事件 (readEvent)：获取日历事件的详细信息。
- 创建日历事件 (createEvent)：创建新的日历事件，支持设置时间、地点、参与者等。

安装步骤

前提条件:
- 确保已安装 Node.js (v14 或更高版本) 和 npm (v6 或更高版本)。
- 拥有 Google Cloud Platform 账户，并已启用 Gmail API 和 Calendar API。
- 创建 OAuth 2.0 客户端凭据，并配置相应的 API 访问权限（scopes）。

克隆仓库并安装依赖:

git clone [仓库URL]  # 将 [仓库URL] 替换为实际的仓库地址，例如 https://github.com/zacco16/gmail-mcp-server
cd gmail-mcp-server
npm install

配置环境变量:
- 复制 '.env.example' 文件并重命名为 '.env'。
- 编辑 '.env' 文件，填入您的 Google API 凭据，包括 'GOOGLE_CLIENT_ID', 'GOOGLE_CLIENT_SECRET', 'REDIRECT_URI' 和 'GOOGLE_REFRESH_TOKEN'。
- 获取 'GOOGLE_REFRESH_TOKEN': 首次运行服务器前，需要先运行 'server.js' 文件，访问 'http://localhost:4100/auth' 完成 OAuth 授权流程。授权成功后，刷新令牌 (refresh token) 将会打印在控制台中，复制该令牌并填入 '.env' 文件中的 'GOOGLE_REFRESH_TOKEN' 字段。
```
cp .env.example .env
# 编辑 .env 文件，填入您的 Google API 凭据
```
构建服务器:
```
npm run build
```
启动服务器:
```
npm start
```

服务器配置 (MCP 客户端配置)

以下 JSON 配置信息用于配置 MCP 客户端以连接到 Gmail MCP Server。请将以下配置添加到您的 MCP 客户端的服务器配置中：

{
  "serverName": "gmail-mcp-server",
  "command": "node",
  "args": [
    "dist/index.js" // 服务器入口文件路径，构建后位于 dist 目录
  ]
}

基本使用方法

服务器启动后，MCP 客户端可以通过标准输入/输出 (stdio) 与服务器进行通信。客户端可以发送符合 MCP 协议的 JSON-RPC 请求，调用服务器提供的工具，例如：

调用 'listEmails' 工具列出邮件
调用 'readEmail' 工具读取指定邮件
调用 'createEvent' 工具创建日历事件

具体的工具调用方法和参数，请参考仓库中 'src/tools' 目录下各个工具的定义和 'README.md' 文档。

关键词

Gmail MCP Server 使用说明

信息