使用说明

项目简介

'mcp-github-pera1' 是一个基于 Model Context Protocol (MCP) 的服务器，它充当大型语言模型 (LLM) 访问 GitHub 代码仓库的桥梁。该服务器利用 Pera1 服务从指定的 GitHub 仓库中提取代码，并将其作为上下文信息提供给 LLM，例如 Claude.ai。这使得 LLM 能够更好地理解和处理与 GitHub 代码相关的问题。

主要功能点

GitHub 代码检索: 允许 LLM 通过提供 GitHub 仓库的 URL 来检索仓库中的代码内容。
代码过滤: 支持通过目录、文件扩展名等参数过滤检索的代码，以便更精确地获取所需代码片段。
Pera1 集成: 使用 Pera1 服务作为后端，高效地从 GitHub 仓库抓取和处理代码数据。
MCP 协议支持: 遵循 MCP 协议标准，可以与任何兼容 MCP 协议的 LLM 客户端协同工作。

安装步骤

由于该 MCP 服务器以 npm 包的形式发布，推荐使用 npm 进行安装。

确保 Node.js 和 npm 已安装: 您的系统需要预先安装 Node.js 和 npm (Node 包管理器)。
全局安装 npm 包: 打开终端或命令提示符，运行以下命令全局安装 '@kazuph/mcp-github-pera1' 包：
```
npm install -g @kazuph/mcp-github-pera1
```
或者，您也可以选择在项目本地安装，并使用 'npx' 运行。

服务器配置

要将 'mcp-github-pera1' 服务器配置到 MCP 客户端，您需要编辑 MCP 客户端的配置文件。以 Claude 桌面应用为例，配置步骤如下：

找到配置文件: Claude 桌面应用的配置文件通常位于 '~/Library/Application Support/Claude/claude_desktop_config.json' (macOS) 或相应的用户配置目录下 (Windows/Linux)。
编辑配置文件: 打开 'claude_desktop_config.json' 文件，在 'mcpServers' 字段下添加 'github' 服务器的配置。如果 'mcpServers' 字段不存在，请创建它。
```
{
  "mcpServers": {
    "github": {
      "command": "npx",
      "args": ["-y", "@kazuph/mcp-github-pera1"]
    }
  }
}
```
- 'server name': 'github' (服务器名称，可以自定义，用于在客户端中标识)
- 'command': 'npx' (Node 包执行器，用于运行 npm 包)
- 'args': '["-y", "@kazuph/mcp-github-pera1"]' (启动服务器的参数，'-y' 可能是 'yes' 的缩写，用于自动确认执行)

基本使用方法

配置完成后，在 Claude 或其他 MCP 客户端中，您可以直接向 LLM 提问关于 GitHub 代码仓库的问题。例如：

Tell me about the implementation of GitHub repository https://github.com/username/repository

您还可以利用以下参数更精确地控制代码检索范围：

'url': GitHub 仓库 URL (必填)
'dir': 指定仓库内的目录路径 (可选，用于过滤特定目录下的代码，多个目录用逗号分隔)
'ext': 指定文件扩展名 (可选，用于过滤特定类型的文件，多个扩展名用逗号分隔)
'mode': 显示模式 (可选，例如 'tree' 模式可能仅显示目录结构)
'branch': 指定分支名称 (可选，用于检索特定分支的代码)

例如，要检索 'https://github.com/modelcontextprotocol/servers' 仓库 'develop' 分支下 'src/fetch' 目录中的 TypeScript 和 JavaScript 代码，可以在提问中包含这些信息，或者在工具调用参数中指定。具体使用方式取决于 MCP 客户端的实现。

关键词