Google Workspace MCP Server 使用说明
项目简介
Google Workspace MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在让 LLM 客户端能够安全、便捷地访问和控制用户的 Google Workspace 数据和服务。通过标准化的 MCP 协议,该服务器向 LLM 应用提供上下文信息和执行外部功能的能力,例如读取 Gmail 邮件、管理日历事件、操作 Google Drive 文件等,从而增强 LLM 应用在 Google Workspace 环境下的智能化应用能力。
主要功能点
- 资源 (Resources) 管理: 托管和管理用户的 Google Workspace 账户,安全存储和管理 OAuth 认证信息。
- 工具 (Tools) 注册与执行: 提供丰富的工具集,涵盖 Gmail 邮件、日历事件、Google Drive 文件等操作,允许 LLM 客户端通过调用工具执行各种 Google Workspace 功能,例如:
- 邮件: 搜索邮件、发送邮件、管理草稿、管理标签、管理过滤器、下载/上传附件。
- 日历: 列出/查看/创建/更新/删除日历事件、管理事件回复。
- 云盘: 列出/搜索文件、上传/下载/删除文件、创建文件夹、更新文件权限。
- Prompt 模板 (Prompts): 虽然仓库文档中没有明确提及 Prompt 模板,但 MCP 服务器的架构设计支持 Prompt 模板的集成,以便未来扩展定制化的 LLM 交互模式(当前仓库未实现)。
- 标准化 MCP 协议: 通过 JSON-RPC 协议与客户端通信,支持 Stdio 标准输入输出流传输协议,方便与各种 MCP 客户端集成。
- 安全与可扩展性: 服务器端负责会话管理、能力声明,保障数据访问安全;支持 Docker 部署,易于扩展和维护。
安装步骤
-
创建 Google Cloud 项目:
- 访问 Google Cloud Console 并创建一个新的项目。
- 在项目中启用 Gmail API、Google Calendar API 和 Google Drive API。
- 配置 OAuth 同意屏幕,选择 "外部" 类型,并将您自己添加为测试用户。
- 创建 OAuth 2.0 凭据,选择 "桌面应用程序" 类型,记录下 客户端 ID (Client ID) 和 客户端密钥 (Client Secret)。重定向 URI 使用 'urn:ietf:wg:oauth:2.0:oob'。
-
配置 MCP 客户端设置:
- 以 Cline 为例,修改 Cline 的 MCP 设置文件 ('~/.config/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json'),添加 Google Workspace MCP Server 的配置。
服务器配置
以下 JSON 配置信息用于 MCP 客户端 (如 Cline) 连接 Google Workspace MCP Server。请根据您的实际环境进行调整。
{ "mcpServers": { "google-workspace-mcp": { // 服务器名称,客户端中引用此名称 "command": "docker", // 启动服务器的命令,这里使用 Docker "args": [ // 命令参数 "run", // Docker run 命令 "--rm", // 容器退出后自动删除 "-i", // 保持 STDIN 打开 "-v", "/path/to/your/config:/app/config", // 挂载配置文件目录,将宿主机上的配置目录映射到容器内 "-v", "/path/to/your/workspace:/app/workspace", // 挂载工作区目录,用于存储下载/上传的文件 "-e", "GOOGLE_CLIENT_ID", // 传递 Google OAuth 客户端 ID 环境变量 "-e", "GOOGLE_CLIENT_SECRET", // 传递 Google OAuth 客户端密钥环境变量 "-e", "LOG_MODE=strict", // 设置日志模式为 strict,推荐 Cline 桌面端使用 "ghcr.io/aaronsb/google-workspace-mcp:latest" // Docker 镜像名称 ], "env": { // 环境变量配置 "GOOGLE_CLIENT_ID": "YOUR_CLIENT_ID", // 替换为您的 Google OAuth 客户端 ID "GOOGLE_CLIENT_SECRET": "YOUR_CLIENT_SECRET" // 替换为您的 Google OAuth 客户端密钥 }, "autoApprove": [], // 自动批准的工具列表 (当前为空) "disabled": false // 是否禁用该服务器,false 为启用 } } }
配置参数说明:
- '"command": "docker"': 指定使用 Docker 运行服务器。
- '"args"': Docker 运行参数,包括:
- '"-v", "/path/to/your/config:/app/config"': 重要: 将宿主机上的配置目录 '/path/to/your/config' 替换为您实际存放 'accounts.json' 等配置文件的目录。
- '"-v", "/path/to/your/workspace:/app/workspace"': 重要: 将宿主机上的工作区目录 '/path/to/your/workspace' 替换为您希望用于存储下载和上传文件的目录。
- '"-e", "GOOGLE_CLIENT_ID"' 和 '"-e", "GOOGLE_CLIENT_SECRET"': 通过环境变量传递您的 Google OAuth 客户端 ID 和密钥。
- '"-e", "LOG_MODE=strict"': 设置日志模式为 'strict',推荐与 Cline 等 MCP 客户端配合使用,将非 JSON-RPC 消息输出到 stderr。
- '"ghcr.io/aaronsb/google-workspace-mcp:latest"': 指定使用的 Docker 镜像。
- '"env"': 环境变量,用于配置 'GOOGLE_CLIENT_ID' 和 'GOOGLE_CLIENT_SECRET'。请务必替换为您的真实凭据。
首次启动服务器前,请务必将 'config' 目录下的 'accounts.example.json' 复制为 'accounts.json',并根据需要修改配置。
基本使用方法
- 启动 MCP 服务器: 根据上述配置,启动 Docker 容器运行 Google Workspace MCP Server。
- 连接 Google 账户: 在 MCP 客户端中配置并连接到 'google-workspace-mcp' 服务器。首次使用时,客户端会引导您完成 Google 账户的身份验证流程。
- 使用工具: 通过 MCP 客户端,您可以调用服务器提供的各种工具来操作 Google Workspace 服务。例如,在 Cline 中,您可以直接向 AI 助手发出指令,例如 "搜索我的 Gmail 中关于会议的邮件"、"创建一个明天上午 10 点的日历事件" 等,AI 助手将自动调用相应的 MCP 工具完成操作。
详细工具列表及 API 使用方法,请参考仓库中的 API Documentation 文档。
信息
分类
生产力应用