Gmail MCP Server Yv2

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

本 MCP 服務器與 Gmail 深度集成，為用戶提供了強大且便捷的電子郵件管理功能，涵蓋發送、刪除、閱讀、撰寫和回覆等操作。

⚠️ 重要提示

此服務器允許 MCP 客戶端讀取、刪除和發送電子郵件。不過，客戶端會在執行此類操作之前提示用戶。

GitHub 資源鏈接

🚀 快速開始

按照以下步驟，您可以輕鬆將 Gmail MCP 服務器集成到您的應用中。

✨ 主要特性

• 多功能集成：支持發送、刪除、閱讀、撰寫和回覆電子郵件等常見操作。
• 用戶友好：客戶端在執行敏感操作前會提示用戶，保障用戶信息安全。

📦 安裝指南

安裝依賴

使用 pip 安裝所需的庫（如 google-api-python-client 等）。

配置環境變量

設置 Google API 准入信息，包括客戶端 ID 和客戶端密鑰。

啟動服務器

使用提供的命令啟動服務器，並指定 --creds-file-path 和 access-tokens-file 的路徑。

💻 使用示例

基礎用法

以下是使用各個工具的示例：

# 發送郵件
# 假設已經完成認證和環境配置
from your_module import send_email
recipient_id = "example@example.com"
subject = "Test Email"
message = "This is a test message."
status, message_id = send_email(recipient_id, subject, message)

# 將郵件移到垃圾箱
from your_module import trash_email
email_id = "1234567890"
success_message = trash_email(email_id)

# 標記郵件為已讀
from your_module import mark_email_as_read
email_id = "1234567890"
success_message = mark_email_as_read(email_id)

# 檢索未讀郵件
from your_module import get_unread_emails
unread_emails = get_unread_emails()

# 檢索指定郵件內容
from your_module import read_email
email_id = "1234567890"
email_metadata = read_email(email_id)

# 在瀏覽器中打開郵件
from your_module import open_email
email_id = "1234567890"
success_message = open_email(email_id)

📚 詳細文檔

組件

工具

• 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。
  • 返回值：成功消息並打開指定電子郵件在默認瀏覽器中。

設置

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 傳遞此文件的絕對路徑。

認證

啟動服務器時，認證流程將在您的系統瀏覽器中自動啟動。

• 按照屏幕上的指示授予權限即可完成設置。

🔧 技術細節

本服務器通過與 Gmail API 交互實現各項功能。在啟動服務器時，會通過指定的 --creds-file-path 參數加載 OAuth 密鑰文件，完成認證流程後，即可調用 Gmail API 進行郵件的管理操作。

📄 故障排除

• 如果遇到問題，請檢查以下內容：
  • 確保 Google API 項目已正確配置。
  • 確保 OAuth 流程已完成且沒有錯誤。
  • 檢查日誌以獲取更多信息。

通過以上步驟，您可以成功設置 Gmail MCP 服務器並集成到您的應用中！