MCP Google Workspace

🚀 模型上下文協議谷歌工作區服務器

本項目提供了與谷歌工作區服務器交互的功能，可實現賬戶管理、郵件操作、日曆管理等功能，通過簡單的命令即可完成各種任務。

🚀 快速開始

安裝項目依賴

通過運行以下命令安裝項目依賴：

npm install

啟動服務

運行以下命令以啟動服務器：

npm start

可選參數：

• --gauth-file：指定OAuth2憑證文件路徑（默認為./.gauth.json）
• --accounts-file：指定賬戶配置文件路徑（默認為./.accounts.json）
• --credentials-dir：指定存儲OAuth憑證的目錄（默認為當前目錄）

示例：

npm start -- --gauth-file ./config/gauth.json --accounts-file ./config/accounts.json

✨ 主要特性

賬戶管理

• 可列出所有配置的谷歌賬戶，顯示賬戶元數據和描述。

郵件功能工具

• 支持使用Gmail查詢語法搜索郵件。
• 可獲取單個或批量郵件的完整內容。
• 能創建、刪除郵件草稿，回覆郵件。
• 支持下載單個或批量郵件附件。
• 可將郵件移出收件箱（存檔）。

日曆功能工具

• 可列出所有可訪問的日曆，顯示日曆元數據、訪問權限和時區信息。
• 能在指定日期範圍內獲取事件，支持多個日曆和過濾選項。
• 可創建和刪除日曆事件。

📦 安裝指南

通過運行以下命令安裝項目依賴：

npm install

💻 使用示例

基礎用法

啟動服務器

npm start

列出所有配置的谷歌賬戶

gmail_list_accounts

搜索郵件

gmail_query_emails 'is:unread'

高級用法

啟動服務器並指定配置文件

npm start -- --gauth-file ./config/gauth.json --accounts-file ./config/accounts.json

批量獲取郵件

gmail_bulk_get_emails id1 id2 id3

📚 詳細文檔

可用工具

賬戶管理

1. 列出所有配置的谷歌賬戶
   • 命令：gmail_list_accounts 或 calendar_list_accounts
   • 功能：顯示所有已配置的谷歌賬戶信息，包括賬戶元數據和描述
   • 無用戶ID要求

郵件功能工具

1. 搜索郵件

   • 命令：gmail_query_emails
   • 功能：使用Gmail的查詢語法搜索郵件（例如：'is:unread', 'from:example@gmail.com', 'newer_than:2d', 'has:attachment'）
   • 返回按逆時間順序排列的郵件列表，包含元數據和內容摘要

2. 獲取郵件

   • 命令：gmail_get_email
   • 功能：通過ID獲取完整的郵件內容，包括正文和附件信息

3. 批量獲取郵件

   • 命令：gmail_bulk_get_emails
   • 功能：一次性獲取多個郵件的完整內容，適合批量處理

4. 創建草稿

   • 命令：gmail_create_draft
   • 功能：新建郵件草稿
   • 支持Cc收件人

5. 刪除草稿

   • 命令：gmail_delete_draft
   • 功能：通過ID刪除草稿郵件

6. 回覆郵件

   • 命令：gmail_reply
   • 功能：回覆現有郵件
   • 選項：立即發送或保存為草稿
   • 支持Cc（所有收件人）

7. 獲取附件

   • 命令：gmail_get_attachment
   • 功能：下載郵件附件
   • 選項：保存到本地磁盤或作為嵌入資源返回

8. 批量保存附件

   • 命令：gmail_bulk_save_attachments
   • 功能：一次性保存多個附件

9. 存檔郵件

   • 命令：gmail_archive 或 gmail_bulk_archive
   • 功能：將郵件移出收件箱
   • 支持單個或批量操作

日曆功能工具

1. 列出日曆

   • 命令：calendar_list
   • 功能：顯示所有可訪問的日曆，包含日曆元數據、訪問權限和時區信息

2. 獲取事件

   • 命令：calendar_get_events
   • 功能：在指定日期範圍內獲取事件，支持多個日曆和過濾選項（刪除的事件、最大結果數），時區自定義

3. 創建事件

   • 命令：calendar_create_event
   • 功能：新建日曆事件，支持參與者和提醒，支持位置和描述字段，時區處理

4. 刪除事件

   • 命令：calendar_delete_event
   • 功能：通過ID刪除事件

項目結構

src/
├── main.ts        # 主程序入口
├── config/       # 配置文件夾
│   ├── gauth.json
│   └── accounts.json
└── utils/         # 工具函數
    ├── gmail-service.ts
    └── calendar-service.ts

開發命令

# 啟動開發服務器
npm run dev

# 構建項目
npm run build

# 運行測試
npm test

📄 許可證

本項目使用MIT許可證，具體請參見LICENSE文件。