MCP Github Mapper

🚀 GitHub 映射器 MCP 服務器

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

🚀 快速開始

GitHub Mapper 是一個功能強大的工具，能幫助您高效地映射和分析 GitHub 倉庫。以下是快速開始使用它的步驟：

1. 確保滿足先決條件：安裝 Node.js（建議 v18.0.0 或更高版本）和 npm，同時獲取具有適當權限的 GitHub 個人訪問令牌。
2. 選擇合適的安裝方式：可以通過 Smithery 自動安裝，也能手動克隆倉庫並安裝依賴。
3. 啟動服務器：運行 npm start 命令，服務器將在 stdio 上運行，允許與 MCP 客戶端通信。

✨ 主要特性

• 身份驗證：支持設置 GitHub 個人訪問令牌進行身份驗證，保障數據訪問的安全性。
• 倉庫映射與分析：能夠精準映射和分析 GitHub 倉庫的結構，讓您對倉庫的組織架構一目瞭然。
• 信息檢索：可快速檢索倉庫的摘要信息，如星標數、分支數、使用的編程語言等。
• 詳細結構展示：提供詳細的倉庫文件結構，方便您深入瞭解倉庫內容。

📦 安裝指南

使用 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

服務器將在 stdio 上運行，允許與 MCP 客戶端通信。

設置 GitHub 個人訪問令牌

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

您可以在 這裡 創建個人訪問令牌，選擇經典令牌，範圍設置為 repo。

映射 GitHub 倉庫

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

高級用法

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

在 package.json 文件中添加以下內容：

{
  "name": "your-app-name",
  "version": "1.0.0",
  "description": "Your app description here",
  "main": "index.js",
  "scripts": {
    "start": "node index.js"
  },
  "dependencies": {
    "github-mapper": "^1.2.3"
  }
}

📚 詳細文檔

示例輸出

摘要信息

{
  "倉庫名稱": "your-repository-name",
  "星標數": 123,
  "分支數量": 45,
  "語言": "JavaScript",
  "主要依賴項": ["express", "react"]
}

倉庫結構

.
├── README.md
├── package.json
├── index.js
└── src/
    ├── components/
    │   └── App.jsx
    └── services/
        └── api.js

圖片

• GitHub Mapper 的示例圖像：圖片鏈接
• GitHub 令牌設置的示例圖像：圖片鏈接

錯誤處理

如果遇到問題，請檢查以下常見錯誤：

• 未設置令牌：確保已運行 set-github-token 命令。
• 無效 URL：確認倉庫 URL 正確無誤。

貢獻

歡迎為 GitHub Mapper 提交問題和拉取請求！請在 GitHub 倉庫 中查看貢獻指南。

📄 許可證

此項目受 MIT License 保護。