GitHub仓库分析工具

GitHub Mapper是一个模型上下文协议(MCP)服务器,提供映射和分析GitHub仓库的工具,包括仓库结构和摘要统计信息。

  • by dazeb
  • TypeScript
  • 本地部署
  • 24 星标
  • 更新于
在 GitHub 查看 dazeb/MCP-Github-Mapper

使用说明

GitHub映射器MCP服务器

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

特性

  • 设置GitHub个人访问令牌进行身份验证
  • 映射和分析GitHub存储库结构
  • 检索存储库摘要信息(星号、叉号、语言等)
  • 提供详细的存储库文件结构

先决条件

  • Node.js(建议使用v18.0.0或更高版本)
  • npm(附带Node.js)
  • 具有适当权限的GitHub个人访问令牌

安装

通过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. 服务器将在stdio上运行,使其能够与MCP客户端通信。

可用工具

1. set-github-token

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

  • 创建您的个人访问令牌 这里。选择令牌(经典)。范围:回购

例如,在IDE或Claude桌面中:

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包加载一个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许可证获得许可。