【技术文档摘要】：

GitHub Mapper MCP 服务器

GitHub Mapper 是一个模型上下文协议 (MCP) 服务器，提供用于映射和分析 GitHub 存储库的工具。它允许用户设置 GitHub 个人访问令牌，并检索指定存储库的详细信息，包括其结构和汇总统计信息。

功能

• 设置 GitHub 个人访问令牌进行身份验证
• 映射和分析 GitHub 存储库结构
• 检索存储库汇总信息（星标数、分叉数、语言等）
• 提供详细的存储库文件结构

预备条件

• Node.js（推荐 v18.0.0 或更高版本）
• npm（随 Node.js 一起提供）
• 具有适当权限的 GitHub 个人访问令牌

安装

通过 Smithery 安装

要通过 Smithery 自动安装 GitHub Mapper for Claude Desktop：

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
   

使用方法

1. 启动服务器：

   npm start
   

2. 服务器将在标准 I/O 上运行，允许与 MCP 客户端通信。

可用工具

1. set-github-token

设置 GitHub 个人访问令牌进行身份验证。

• 在 这里 创建您的个人访问令牌。选择 Tokens (classic)。范围：repo

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

请将 GitHub 访问令牌设置为 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

2. map-github-repo

映射 GitHub 存储库结构并提供汇总信息。

示例：

请映射 GitHub 存储库 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 上的第一个存储库！
星标数：1234
分叉数：567
主要语言：JavaScript
创建时间：2023-01-01
最后更新时间：2023-06-15

存储库结构：

{
  "src": {
    "components": {
      "Header.js": null,
      "Footer.js": null
    },
    "pages": {
      "index.js": null,
      "about.js": null
    },
    "styles": {
      "global.css": null
    }
  },
  "public": {
    "images": {
      "logo.png": null
    },
    "favicon.ico": null
  },
  "package.json": null,
  "README.md": null
}

图片

运行评估

Evals 包加载了一个 mcp 客户端，然后运行 index.ts 文件，因此在测试之间无需重新构建。您可以通过在 npx 命令前添加环境变量来加载它们。完整的文档可以在这里找到 这里。

OPENAI_API_KEY=your-key  npx mcp-eval src/evals/evals.ts src/index.ts

错误处理

• 如果未设置 GitHub 令牌，您将收到错误消息，提示您首先使用 set-github-token 工具。
• 无效的 GitHub URL 或存储库路径将导致适当的错误消息。

贡献

欢迎贡献！请随时提交拉取请求。

许可证

本项目采用 MIT 许可证。