🚀 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 保护。