Loglmhq MCP Server Github Repo

🚀 GitHub 倉庫 MCP 協議服務器

本項目實現了一個支持 Model Context Protocol (MCP) 的服務器，旨在為 AI 助手提供訪問 GitHub 倉庫內容的能力，讓其可以瀏覽並讀取指定倉庫中的文件，極大地拓展了 AI 助手獲取信息的範圍。

🚀 快速開始

配置環境變量

服務器運行依賴以下環境變量，請在運行前進行配置：

GITHUB_PERSONAL_ACCESS_TOKEN=your_github_token
GITHUB_OWNER=repository_owner
GITHUB_REPO=repository_name
GITHUB_BRANCH=branch_name  # 可選

安裝依賴與構建

安裝項目所需的依賴項：

npm install

構建服務器：

npm run build

若需要在開發過程中實現自動重建功能，可使用以下命令：

npm run watch

安裝與配置

若要與 Claude 桌面配合使用，需要在相應的配置文件中添加服務器配置：

• MacOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%/Claude/claude_desktop_config.json

在配置文件中添加如下內容：

{
  "mcpServers": {
    "mcp-server-github-repo": {
      "command": "/path/to/mcp-server-github-repo/build/index.js"
    }
  }
}

✨ 主要特性

資源訪問

• 靈活的文件訪問：可通過 URI 訪問倉庫中的任意文件。
• 目錄導航：支持列出倉庫內容並導航目錄。
• 多分支支持：允許訪問特定分支下的文件。
• 純文本輸出：文件內容以純文本形式提供。

資源 URI 格式

• 基本 URL 格式：https://api.github.com/repos/{owner}/{repo}/contents/{path}
• 類型支持：既支持文件訪問，也支持目錄訪問。文件使用 text/plain MIME 類型，目錄使用 application/x-directory MIME 類型。

📦 安裝指南

與 Claude 桌面集成

按照上述配置位置和配置內容，將服務器配置添加到 Claude 桌面的配置文件中，即可完成安裝。

💻 使用示例

演示

📚 詳細文檔

API 實現

服務器實現了三個主要的 MCP 端點：

1. ListResources - 用於列出倉庫中的文件和目錄。
2. ReadResource - 用於獲取特定文件的內容。

認證

服務器採用 GitHub 個人訪問令牌進行認證。請確保您的令牌具備訪問倉庫內容的適當權限。

錯誤處理

服務器具備完善的錯誤處理功能，可處理以下常見錯誤：

• 環境變量缺失
• GitHub API 錯誤
• 無效路徑（例如嘗試將目錄讀取為文件）
• 認證失敗

🔧 技術細節

調試

由於 MCP 服務器通過 stdio 通信，調試可能存在一定挑戰。您可以使用 MCP 檢查器進行調試：

npm run inspector

運行該命令後，將提供一個可在瀏覽器中訪問調試工具的 URL。

安全注意事項

• 請妥善保管您的 GitHub 個人訪問令牌，避免洩露。
• 建議使用權限最小的令牌，以降低安全風險。
• 在訪問大型倉庫時，需注意倉庫大小限制。

📄 許可證

本項目採用 MIT 許可證。