使用说明

项目简介

Google Workspace MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,旨在为大型语言模型 (LLM) 提供与 Google Workspace 服务(如 Gmail 和 Google 日历)交互的能力。通过此服务器,LLM 可以调用预定义的工具来管理用户的电子邮件和日历事件,从而扩展 LLM 的应用场景和功能。

主要功能点

  • Gmail 工具
    • 'list_emails':列出最近的邮件,可按条件过滤。
    • 'search_emails':根据 Gmail 查询语法搜索邮件。
    • 'send_email':发送新邮件,支持抄送和密送。
    • 'modify_email':修改邮件标签,例如归档、删除、标记已读/未读。
  • 日历工具
    • 'list_events':列出未来的日历事件,可按日期范围过滤。
    • 'create_event':创建新的日历事件,可添加参与者。
    • 'update_event':更新已有的日历事件。
    • 'delete_event':删除日历事件。

安装步骤

  1. 安装 Node.js: 确保已安装 Node.js 14 或更高版本。
  2. 配置 Google Cloud Console:
    • 访问 Google Cloud Console 并创建一个新项目或选择现有项目。
    • 启用 Gmail API 和 Google Calendar API。
    • 设置 OAuth 2.0 凭据,选择“Web 应用程序”类型,并将“已授权的重定向 URI”设置为 'http://localhost:4100/code'。记录 Client ID 和 Client Secret。
  3. 克隆仓库并安装依赖:
    git clone https://github.com/epaproditus/google-workspace-mcp-server.git
    cd google-workspace-mcp-server
    npm install
  4. 创建 OAuth 凭据文件: 在仓库根目录下创建 'credentials.json' 文件,填入你的 Client ID 和 Client Secret:
    {
        "web": {
            "client_id": "YOUR_CLIENT_ID",
            "client_secret": "YOUR_CLIENT_SECRET",
            "redirect_uris": ["http://localhost:4100/code"],
            "auth_uri": "https://accounts.google.com/o/oauth2/auth",
            "token_uri": "https://oauth2.googleapis.com/token"
        }
    }
  5. 获取 Refresh Token: 运行命令 'node get-refresh-token.js'。这将打开浏览器进行 Google 身份验证,授权后,RefreshToken 将显示在控制台,并保存到 'token.json' 文件中。
  6. 构建项目: 运行命令 'npm run build'。

服务器配置

要将此 MCP 服务器配置到 MCP 客户端(例如 Claude 的 VSCode 扩展或桌面应用),请将以下 JSON 配置添加到客户端的 MCP 设置中。请根据实际情况修改 'command' 和 'args' 中的路径,并替换 'env' 中的凭据信息。

{
  "mcpServers": {
    "google-workspace": {
      "command": "node",
      "args": ["/path/to/google-workspace-server/build/index.js"], // 请替换为你的 google-workspace-server 仓库 build 目录下的 index.js 文件的实际路径
      "env": {
        "GOOGLE_CLIENT_ID": "YOUR_CLIENT_ID", // 替换为你的 Google Client ID
        "GOOGLE_CLIENT_SECRET": "YOUR_CLIENT_SECRET", // 替换为你的 Google Client Secret
        "GOOGLE_REFRESH_TOKEN": "YOUR_REFRESH_TOKEN" // 替换为你的 Google Refresh Token
      }
    }
  }
}

基本使用方法

配置完成后,MCP 客户端将能够发现并调用此服务器提供的工具。你可以通过 MCP 客户端发送 JSON-RPC 请求来调用工具,例如列出邮件、发送邮件、创建日历事件等。具体的请求参数和使用示例请参考仓库 README.md 文件中的 "Usage Examples" 部分。

信息

分类

生产力应用