Github Mapper

🚀 GitHub 倉庫映射 MCP 服務器

GitHub Mapper 是一款基於 Model Context Protocol (MCP) 的服務器，它為用戶提供了強大的工具，用於映射和分析 GitHub 倉庫。藉助該服務器，用戶只需設置 GitHub 個人訪問令牌，就能輕鬆獲取指定倉庫的詳細信息，包括倉庫結構和摘要統計信息。

🚀 快速開始

GitHub Mapper 是一個 Model Context Protocol (MCP) 服務器，提供用於映射和分析 GitHub 倉庫的工具。它允許用戶設置 GitHub 個人訪問令牌並獲取指定倉庫的詳細信息，包括其結構和摘要統計信息。

✨ 主要特性

• 設置 GitHub 個人訪問令牌以進行身份驗證
• 映射和分析 GitHub 倉庫結構
• 獲取倉庫摘要信息（stars、forks、語言等）
• 提供詳細的倉庫文件結構

📦 安裝指南

使用 Smithery 進行自動安裝

通過 Smithery 自動在 Claude Desktop 上安裝 GitHub Mapper：

npx -y @smithery/cli install github-mapper-mcp-server --client claude

手動安裝

1. 克隆倉庫：

   git clone https://github.com/your-username/github-mapper-mcp-server.git
   cd github-mapper-mcp-server
   

2. 安裝依賴項：

   npm install
   

3. 構建項目：

   npm run build
   

💻 使用示例

基礎用法

啟動服務器

npm start

服務器將在標準輸入輸出上運行，允許與 MCP 客戶端通信。

高級用法

1. set-github-token

設置 GitHub 個人訪問令牌以進行身份驗證。

• 在此處創建您的個人訪問令牌 here。選擇經典令牌。範圍：repo

示例，在您的 IDE 或 Claude Desktop 中：

請設置-github-token為 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

2. map-github-repo

映射 GitHub 倉庫結構並提供摘要信息。

示例：

請映射-github-repo https://github.com/dazeb/MCP-Github-Mapper

在 Cline 或 Roo - Cline MCP 客戶端中手動安裝

{
  "mcpServers": {
    "github-mapper": {
      "command": "node",
      "args": ["/home/user/Documents/Cline/MCP/github-mapper/build/index.js"]
    }
  }
}

示例輸出

倉庫分析摘要：

名稱：Hello-World
描述：我在 GitHub 上的第一個倉庫。
Stars 數量：123
Forks 數量：45
語言：JavaScript
貢獻者數量：6

文件結構：
- .github/workflows/
  - ci.yml
- README.md
- package.json
- src/
  - index.js
  - App.js

📚 詳細文檔

先決條件

• Node.js（建議使用 v18.0.0 或更高版本）
• npm（隨 Node.js 提供）
• 帶有適當權限的 GitHub 個人訪問令牌

錯誤處理

• 如果 Node.js 版本不滿足要求，您可能會遇到兼容性問題。
• 如果未設置有效的 GitHub 令牌，映射倉庫功能將無法正常工作。

貢獻

我們歡迎社區貢獻！請參考我們的 CONTRIBUTING.md 文件以瞭解如何參與。

📄 許可證

此項目受 MIT License 保護。