项目简介

GitHub Mapper MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器应用，旨在为大型语言模型 (LLM) 提供 GitHub 仓库的上下文信息。通过此服务器，LLM 客户端可以调用工具来分析 GitHub 仓库，获取仓库的文件结构和基本信息，例如 star 数量、fork 数量、主要编程语言等。这使得 LLM 能够更好地理解和处理与 GitHub 仓库相关的任务，例如代码理解、代码检索、知识库构建等。

主要功能点

设置 GitHub 个人访问令牌: 允许用户通过工具 'set-github-token' 安全地配置 GitHub 个人访问令牌，用于后续的 API 访问认证。
分析 GitHub 仓库结构: 提供工具 'map-github-repo'，根据提供的 GitHub 仓库 URL，返回该仓库的文件目录结构，方便 LLM 理解仓库的代码组织方式。
获取仓库统计信息: 'map-github-repo' 工具同时返回仓库的概要信息，包括仓库名称、描述、star 数量、fork 数量、主要编程语言、创建和更新时间等。
基于标准 MCP 协议: 采用 JSON-RPC over Stdio 通信，易于集成到任何支持 MCP 协议的 LLM 客户端。

安装步骤

克隆仓库:

git clone https://github.com/dazeb/MCP-Github-Mapper.git
cd MCP-Github-Mapper

安装依赖:
```
npm install
```
构建项目:
```
npm run build
```

服务器配置

要将 GitHub Mapper MCP Server 集成到 MCP 客户端，您需要在客户端的 MCP 服务器配置中添加以下 JSON 配置。请根据您的实际安装路径修改 'args' 中的路径。

{
  "mcpServers": {
    "github-mapper": {
      "command": "node",
      "args": ["/path/to/MCP-Github-Mapper/build/index.js"] // 将 "/path/to/MCP-Github-Mapper" 替换为 GitHub Mapper MCP Server 的实际安装路径
    }
  }
}

配置参数说明:

'server name': 'github-mapper' (服务器名称，客户端用此名称引用)
'command': 'node' (启动服务器的命令，这里使用 Node.js 运行 JavaScript 代码)
'args': '["/path/to/MCP-Github-Mapper/build/index.js"]' (传递给 'node' 命令的参数，指向编译后的服务器入口文件 'index.js' 的绝对路径)

请注意: 您需要将 '/path/to/MCP-Github-Mapper' 替换为您在本地克隆和构建 'MCP-Github-Mapper' 仓库的实际路径。例如，如果您的仓库克隆在用户目录下的 'Documents/MCP/github-mapper' 文件夹中，并且您在 'github-mapper' 文件夹下执行了 'npm run build'，则 'args' 应该配置为 '["/home/user/Documents/MCP/github-mapper/build/index.js"]' （在 Windows 系统下，路径格式可能有所不同）。

基本使用方法

启动服务器: 在 MCP 客户端中配置并启动 'github-mapper' 服务器。
设置 GitHub Token: 在 MCP 客户端中，使用以下格式调用 'set-github-token' 工具，并替换为您自己的 GitHub Personal Access Token。您需要先在 GitHub 令牌设置页面创建一个具有 'repo' 权限的 Personal Access Token。
```
Please set-github-token to <您的 GitHub Personal Access Token>
```

分析 GitHub 仓库: 使用以下格式调用 'map-github-repo' 工具，并替换为您要分析的 GitHub 仓库的 URL。

Please map-github-repo <GitHub 仓库 URL>

例如：

Please map-github-repo https://github.com/dazeb/MCP-Github-Mapper

服务器将返回包含仓库结构和统计信息的分析结果。

注意:

首次使用 'map-github-repo' 工具前，请务必先使用 'set-github-token' 工具设置 GitHub Personal Access Token。
确保提供的 GitHub 仓库 URL 格式正确且仓库存在。
如果遇到错误，请检查服务器日志或 MCP 客户端的错误提示信息。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息