MCP Github Reader Prod

🚀 MCP GitHub 讀者

MCP GitHub 讀者是一個輕量級的模型上下文協議（MCP）服務器，它能將 GitHub 倉庫帶入大型語言模型的上下文中，方便用戶對倉庫進行分析和數據獲取。

✨ 主要特性

• 基於 API：無需在本地克隆倉庫，直接與 GitHub API 交互。
• 倉庫分析：可獲取任何 GitHub 倉庫的概述和統計信息。
• 文件訪問：既能檢索單個文件內容，也能獲取整個倉庫的文件結構。
• 智能過濾：支持使用通配符和正則表達式來包含或排除文件。
• 緩存支持：通過智能緩存和優化請求模式，避免 GitHub API 限制。
• 搜索功能：可查找匹配特定模式的文件。
• MCP 兼容：能與任何支持模型上下文協議的 LLM 客戶端兼容。
• 提示模板：提供用於常見倉庫分析任務的現成提示模板。

📦 安裝指南

全局安裝（推薦用於 CLI 使用）

npm install -g mcp-github-reader

本地安裝

npm install mcp-github-reader

💻 使用示例

作為獨立服務器運行

# 如果是全局安裝
mcp-github-reader

# 如果是本地安裝
npx mcp-github-reader

與 Claude 集成

對於 npm 安裝

將此添加到您的 Claude Desktop 工具配置中：

"github-reader": {
  "runtime": "node",
  "command": "npx",
  "args": [
    "-y",
    "mcp-github-reader"
  ]
}

對於本地安裝

"github-reader-test": {
  "command": "node",
  "args": [
    "/path/to/your/repo/src/mcp-github-reader.js"
  ]
}

請將 /path/to/your/repo 替換為實際倉庫路徑。

基礎用法

MCP 服務器提供了四個強大的工具來與 GitHub 倉庫交互：

1. 獲取單個文件內容

從 GitHub 倉庫中檢索特定文件的內容。 參數：

2. 獲取整個倉庫內容

從指定倉庫中檢索符合特定模式的所有文件。 參數：

3. 分析倉庫

分析指定倉庫並返回詳細報告。 參數：

4. 搜索文件

在指定倉庫中搜索符合特定查詢的文件。 參數：

高級用法

獲取單個文件內容示例

{
  "name": "get_individual_file_content",
  "parameters": {
    "owner": "skydeckai",
    "repo": "mcp-server-aidd",
    "path": "README.md"
  }
}

獲取整個倉庫內容示例

{
  "name": "get_entire_repo_contents",
  "parameters": {
    "owner": "skydeckai",
    "repo": "mcp-server-aidd",
    "include_patterns": ["*.js", "*.json", "*.md"],
    "exclude_patterns": ["*.test.js", "node_modules/*"],
    "max_files": 30
  }
}

分析倉庫示例

{
  "name": "analyze_repository",
  "parameters": {
    "repository": "skydeckai/mcp-server-aidd",
    "include_files": true
  }
}

📚 詳細文檔

侷限性

• 目前僅支持公共 GitHub 倉庫。
• 不支持私人倉庫或身份驗證。
• 受限於 GitHub API 速率限制（未認證請求每小時 60 次）。

許可證

本項目採用 Apache License 2.0。更多詳細信息請參閱 LICENSE 文件。版權所有 © 2025 SkyDeck AI Inc.