GitHub Mapper MCP Server

GitHub Mapper MCP 服务

GitHub Mapper 是一个 Model Context Protocol (MCP) 服务，提供用于映射和分析 GitHub 仓库的工具。它允许用户设置 GitHub 个人访问令牌，并获取指定仓库的详细信息，包括其结构和汇总统计信息。

功能

• 设置 GitHub 个人访问令牌以进行身份验证
• 映射和分析 GitHub 仓库结构
• 获取仓库摘要信息（星标、复刻、语言等）
• 提供详细的仓库文件结构

前提条件

• Node.js（建议 v18.0.0 或更高版本）
• npm（随 Node.js 提供）
• 具有适当权限的 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
   

用法

1. 启动服务：

   npm start
   

2. 服务将在 stdio 上运行，使其能够与 MCP 客户端通信。

可用工具

1. set-github-token

设置用于身份验证的 GitHub 个人访问令牌。

• 在此处创建你的个人访问令牌。选择 Tokens (classic)。作用域：repo

例如，在你的 IDE 或 Claude Desktop 中：

Please set-github-token to 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

2. map-github-repo

映射 GitHub 仓库结构并提供摘要信息。

示例：

Please map-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"]
    }
  }
}

输出示例

Repository Analysis Summary:

Name: Hello-World
Description: My first repository on GitHub!
Stars: 1234
Forks: 567
Primary Language: JavaScript
Created: 2023-01-01
Last Updated: 2023-06-15

Repository Structure:

{
  "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

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 或仓库路径将导致相应的错误消息。

贡献

欢迎贡献！请随时提交 Pull Request。

许可证

本项目根据 MIT 许可证授权。