Yagms

🚀 Yet Another Gmail MCP 服務器

Yet Another Gmail MCP 服務器提供了一系列工具，可藉助模型上下文協議（MCP）與您的 Gmail 賬戶進行交互，方便您管理郵件。

🚀 快速開始

Gmail MCP 服務器提供了工具，讓您可以通過模型上下文協議（MCP）與 Gmail 賬戶進行交互。下面為您詳細介紹設置與使用方法。

📦 安裝指南

先決條件

1. 為 Gmail API 創建 OAuth 憑證：
   • 前往 Google Cloud Console
   • 創建新項目或選擇現有項目
   • 啟用 Gmail API
   • 創建 OAuth 2.0 憑證（桌面應用）
   • 下載憑證 JSON 文件並保存為 ~/.yagms-oauth.keys.json

構建此項目

1. 安裝 Bun。
2. 構建代碼

bun install
bun run build-gmail # 會在 ./dist/gmail.js 發射

💻 使用示例

身份驗證

在使用 Gmail MCP 服務器之前，需要先進行身份驗證：

# 運行身份驗證流程
bun run dist/gmail.js auth

這將：

• 打開瀏覽器窗口供您登錄 Google 賬戶
• 請求訪問您的 Gmail 賬戶的權限
• 將認證憑證保存到 ~/.yagms-credentials.json

運行服務器

身份驗證完成後，可以運行 Gmail MCP 服務器：

# 啟動服務器
bun run src/gmail.ts

配置

可以通過環境變量自定義 OAuth 憑證和憑證的路徑：

• GMAIL_OAUTH_PATH：OAuth 憑證文件路徑（默認：~/.yagms-oauth.keys.json）
• GMAIL_CREDENTIALS_PATH：保存憑證的路徑（默認：~/.yagms-credentials.json）

可用工具

Gmail MCP 服務器提供以下工具：

1. list - emails：獲取您收件箱中的電子郵件

• 參數：
  • senderEmail（可選）：按發件人郵箱過濾
  • maxResults（可選，默認：10）：要返回的最大郵件數
  • labelIds（可選， 默認：["INBOX"]）：按標籤 ID 過濾

2. get - email：通過 ID 獲取特定電子郵件

• 參數：
  • emailId：要檢索的電子郵件 ID

3. search - emails：使用 Gmail 搜索語法搜索電子郵件

• 參數：
  • query：Gmail 搜索查詢（例如："from:example@gmail.com has:attachment"）
  • maxResults（可選， 默認：10）：要返回的最大郵件數

4. get - labels：獲取所有 Gmail 標籤

• 無需參數

示例 MCP 配置

將此內容添加到您的 MCP 設置文件中：

{
  "mcpServers": {
    "gmail": {
      "command": "bun",
      "args": ["run", "/path/to/yagms/dist/gmail.js"],
      "env": {},
      "disabled": false,
      "autoApprove": []
    }
  }
}