Highlight Github MCP

🚀 GitHub 集成

GitHub MCP 服務器具備從拉取請求中提取 diff 的強大功能，能有效助力開發者處理代碼變更。

🚀 快速開始

在使用該服務器前，需完成認證步驟。將 GitHub 個人訪問令牌設置為環境變量：

export GITHUB_TOKEN=<your-github-token>

令牌至少需要 repo 權限才能訪問私有倉庫。對於公共倉庫，帶有 public_repo 權限的令牌即足夠。

✨ 主要特性

• 能夠從 GitHub 拉取請求中檢索 diff 內容。
• 實現了標準錯誤處理，能對不同錯誤情況給出相應反饋。

💻 使用示例

基礎用法

可使用 get_diff_pr 工具從 GitHub 拉取請求中檢索 diff 內容。以下為使用示例：

# 假設這是調用 get_diff_pr 的代碼示例
# 這裡只是示意，具體代碼需根據實際情況編寫
result = get_diff_pr(owner="your_owner", repo="your_repo", pr_number=123)
print(result.content)

高級用法

在實際項目中，可結合錯誤處理機制，確保代碼的健壯性。例如：

try:
    result = get_diff_pr(owner="your_owner", repo="your_repo", pr_number=123)
    print(result.content)
except ErrorCode.AuthenticationError:
    print("認證失敗，請檢查令牌設置")
except ErrorCode.InvalidParams:
    print("倉庫信息無效，請檢查輸入參數")
except ErrorCode.NotFound:
    print("指定的 PR 不存在")

📚 詳細文檔

可用工具

get_diff_pr

從 GitHub 拉取請求中檢索 diff 內容。

返回值：包含以下內容的對象：

• content：字符串，包含 PR 的 diff

認證

要求：將 GitHub 個人訪問令牌設置為環境變量：

export GITHUB_TOKEN=<your-github-token>

令牌至少需要 repo 權限才能訪問私有倉庫。對於公共倉庫，帶有 public_repo 權限的令牌即足夠。

錯誤處理

服務器實現了標準錯誤處理：

• 未設置/無效令牌返回 ErrorCode.AuthenticationError
• 無效的倉庫詳細信息返回 ErrorCode.InvalidParams
• 不存在的 PR 返回 ErrorCode.NotFound
• 獲取 diff 失敗返回格式化錯誤消息
• 收到 SIGINT 信號時優雅關閉

🔧 技術細節

• 使用 Highlight AI MCP SDK 構建。
• 使用 GitHub REST API v3 與 GitHub 進行交互。
• 通過 Zod 進行輸入驗證，確保輸入參數的有效性。
• 作為 stdio 基於的 MCP 服務器運行。
• 支持 Node.js >=18.0.0。

📄 侷限性

• 受到 GitHub API 速率限制的影響，使用時需注意請求頻率。
• 大型 diff 可能會根據 GitHub API 限制被截斷。
• 令牌需要適當的倉庫訪問權限，否則將無法正常訪問。