Gmail MCP Server

🚀 Gmail 服務器用於模型上下文協議（MCP）

本 MCP 服務器與 Gmail 集成，可實現發送、刪除、讀取、草擬和回覆電子郵件等功能，為用戶提供便捷的郵件操作體驗。

⚠️ 重要提示

此服務器使 MCP 客戶端能夠讀取、刪除和發送電子郵件。但是，客戶端會在執行此類活動之前提示用戶。

🚀 快速開始

本 MCP 服務器與 Gmail 集成，可實現發送、刪除、讀取、草擬和回覆電子郵件等功能。以下將詳細介紹其組件、安裝步驟及使用方法。

✨ 主要特性

• 與 Gmail 集成，實現多種郵件操作功能。
• 客戶端在執行敏感操作前會提示用戶，保障用戶信息安全。

📦 安裝指南

Gmail API 設置

1. 創建新的 Google Cloud 項目
2. 啟用 Gmail API
3. 配置 OAuth 同意屏幕
   • 選擇“外部”。但是，我們不會發布此應用程序。
   • 將您的個人電子郵件地址添加為“測試用戶”。
4. 添加 OAuth 範圍 https://www.googleapis.com/auth/gmail/modify
5. 創建應用類型的 OAuth 客戶 ID（例如“桌面應用程序”）
6. 下載您的客戶的 OAuth 密鑰 JSON 文件
7. 重命名密鑰文件並保存到本地計算機的安全位置。注意該文件的位置。
   • 啟動服務器時，將作為參數傳遞的絕對路徑 --creds-file-path。

身份驗證

當服務器啟動時，身份驗證流程將在您的系統瀏覽器中啟動。憑據令牌隨後保存（並在稍後檢索）到指定的絕對文件路徑，該路徑通過參數 --token-path 傳遞。

例如，您可以使用主目錄中的點目錄：

使用說明

要啟動服務器，請運行命令：

python3 src/main.py --config config.yaml

驗證

要驗證服務器是否正常運行，可以執行以下步驟：

1. 發送測試電子郵件。
2. 檢查收件箱以確認電子郵件已送達。

問題排查

如果遇到任何問題，請檢查以下內容：

• 確保 Gmail API 已正確啟用
• 驗證 OAuth 資格憑證是否有效
• 檢查日誌文件以獲取更多信息

📚 詳細文檔

組件

工具

• send-email

  • 功能：向收件人地址發送電子郵件
  • 輸入：
    • recipient_id (字符串)：收件人的電子郵件地址
    • subject (字符串)：郵件主題
    • message (字符串)：郵件內容
  • 返回：狀態和消息 ID

• trash-email

  • 功能：將電子郵件移到垃圾箱
  • 輸入：
    • email_id (字符串)：自動生成的電子郵件 ID
  • 返回：成功消息

• mark-email-as-read

  • 功能：標記電子郵件為已讀
  • 輸入：
    • email_id (字符串)：自動生成的電子郵件 ID
  • 返回：成功消息

• get-unread-emails

  • 功能：檢索未讀電子郵件
  • 返回：電子郵件列表，包括電子郵件 ID

• read-email

  • 功能：檢索給定電子郵件的內容
  • 輸入：
    • email_id (字符串)：自動生成的電子郵件 ID
  • 返回：電子郵件元數據字典並標記電子郵件為已讀

• open-email

  • 功能：在瀏覽器中打開電子郵件
  • 輸入：
    • email_id (字符串)：自動生成的電子郵件 ID
  • 返回：成功消息並在默認瀏覽器中打開指定電子郵件

📄 許可證

版本 1.0.0 - 初始發佈