MCP Github Notifications

🚀 GitHub 通知 MCP 服務器

本項目是一個基於 Model Context Protocol (MCP) 的服務器，它提供了管理 GitHub 通知的工具。藉助該服務器，像 Claude 這樣的 AI 助手能夠通過自然語言命令，協助您高效管理 GitHub 通知。

🚀 快速開始

本服務器允許您藉助 AI 助手，通過自然語言命令管理 GitHub 通知。以下是使用前的準備及操作步驟。

✨ 主要特性

• 列出並過濾您的 GitHub 通知
• 標記通知為已讀
• 查看通知線程詳細信息
• 訂閱或取消訂閱通知線程
• 標記線程為完成
• 管理特定存儲庫的通知
• 控制存儲庫通知設置（所有活動、默認或靜音）

📦 安裝指南

先決條件

• Node.js 18 或更高版本
• 具有 notifications 或 repo 範圍的 GitHub 個人訪問令牌 (classic)

安裝步驟

1. 克隆此倉庫

   git clone https://github.com/yourusername/github-notifications-mcp-server.git
   cd github-notifications-mcp-server
   

2. 安裝依賴項

   npm install
   

3. 構建項目

   npm run build
   

4. 創建包含您的 GitHub 令牌的 .env 文件

   GITHUB_TOKEN=your_github_personal_access_token_here
   

💻 使用示例

直接運行服務器

npm start

與 Claude Desktop 結合使用

將服務器添加到 claude_desktop_config.json 文件中：

{
  "mcpServers": {
    "github-notifications": {
      "command": "node",
      "args": ["/absolute/path/to/github-notifications-mcp-server/build/index.js"],
      "env": {
        "GITHUB_TOKEN": "your_github_personal_access_token_here"
      }
    }
  }
}

可用工具

示例提示

以下是可用於 Claude Desktop 的示例提示，一旦服務器連接成功：

• "你能檢查我的 GitHub 通知嗎？"
• "顯示我過去 24 小時內的未讀通知。"
• "將所有通知標記為已讀。"
• "你能告訴我關於編號 12345 的通知線程嗎？"
• "取消訂閱 12345 號線程的通知。"
• "我在 octocat/Hello-World 倉庫有什麼通知？"
• "將 octocat/Hello-World 倉庫中的所有通知標記為已讀。"
• "關注 octocat/Hello-World 倉庫的所有活動。"
• "將 octocat/Hello-World 倉庫設置為默認設置（參與和 @ 提及）。"
• "檢查我對 octocat/Hello-World 倉庫的通知設置。"
• "使 octocat/Hello-World 倉庫靜音。"

🔧 技術細節

URL 處理

此服務器會自動將 GitHub API URL 轉換為其對應的網絡界面 URL。例如：

• API URL：https://api.github.com/repos/nodejs/node/pulls/57557
• 轉換為：https://github.com/nodejs/node/pull/57557

轉換處理：

• 域名從 api.github.com/repos 到 github.com 的轉換
• 路徑更正，用於拉取請求（將 pulls 更改為 pull）
• 保留額外的路徑段

項目結構

github-notifications-mcp-server/
├── src/                    # 源代碼
│   ├── tools/              # 工具實現
│   ├── types/              # 類型定義
│   ├── utils/              # 工具函數
│   ├── index.js           # 入口文件
│   └── package.json       # 包含依賴項和腳本的文件
└── build/                 # 構建輸出目錄，包含可執行文件

如何構建

在項目根目錄運行以下命令：

npm run build

這將使用 webpack 將所有模塊打包到 build/main.js 中，並且會在構建完成後提供相關信息。

📄 許可證

此項目的許可信息請參考 LICENSE 文件。

這是一個用於管理 GitHub 通知的 MCP 服務器，通過自然語言處理和自動化腳本實現對通知的高效處理。