GitHub Repo MCP

GitHub回购MCP

](https://smithery.ai/server/@Ryan0204/github-repo-mcp)

GitHub Repo MCP is an open-source MCP server that lets your AI assistants browse GitHub repositories, explore directories, and view file contents.

目录

Getting started • Feature overview

✨ 主要特点

• 💻 兼容Cursor、Windsurf、Claude Desktop和其他支持MCP的客户端 stdio 协议
• 🔎 浏览任何公共GitHub存储库的内容
• 📂 浏览存储库目录和子目录
• 📝 查看代码和文本文件的内容
• 📦 通过包管理器轻松安装

入门指南

先决条件

安装服务器需要在系统上执行以下操作：

• Node.js 18+
• npm或纱线

步骤1。安装

您可以使用Smithery、NPX或IDE的MCP.json中的设置安装并运行GitHub Repo MCP：

MacOS

npx github-repo-mcp

Windows NPX

cmd /c npx -y github-repo-mcp

通过.cursor/mcp.json访问Windows NPX

{
  "mcpServers": {
    "github-repo-mcp": {
      "command": "wsl",
      "args": [
        "bash",
        "-c",
        "cmd /c npx -y github-repo-mcp"
      ],
      "enabled": true
    }
  }
}

通过.cursor/mcp.json访问Windows NPX（如果未设置路径）

# Find the full path to npx first
which npx

{
  "mcpServers": {
    "github-repo-mcp": {
      "command": "wsl",
      "args": [
        "bash",
        "-c",
        "'/home/[username]/.nvm/versions/node/v20.18.0/bin/npx github-repo-mcp'"
      ],
      "enabled": true
    }
  }
}

通过Smithery安装

通过以下方式自动安装Claude Desktop的GitHub Repo MCP 史密瑟里:

npx -y @smithery/cli install @Ryan0204/github-repo-mcp --client claude

等待几秒钟，如果没有注册，请单击刷新按钮几次。如果它仍然无法注册，请确保您输入了正确的命令。

步骤2。配置

在访问GitHub API时，GitHub Repo MCP服务器可以使用GitHub令牌来获得更高的速率限制。

环境变量

设置GitHub令牌（可选）

虽然服务器在没有身份验证的情况下工作，但GitHub API对未经身份验证的请求的速率限制要低得多。要提高您的费率限制：

1. 在以下位置创建个人访问令牌https://github.com/settings/tokens
2. 在mcp.json中将令牌设置为环境变量：

{
  "mcpServers": {
    "github-repo-mcp": {
      "command": "...",
      "args": [
        ...
      ],
      "env": {
        "GITHUB_TOKEN": "Your_Github_Token"
      }
      "enabled": true,
    }
  }
}

功能概述

存储库浏览工具

该服务器提供了三种与GitHub存储库交互的主要工具：

1. getRepoAllDirectories

列出GitHub存储库根目录下的所有文件和目录。

• 参数:

- repoUrl：GitHub存储库的URL（例如，“https://github.com/owner/repo")

2. getRepoDirectories

列出GitHub存储库中特定目录的内容。

• 参数:

- repoUrl：GitHub存储库的URL - path：要获取的目录路径（例如“src”）

3. getRepoFile

从GitHub存储库中检索并显示特定文件的内容。

• 参数:

- repoUrl：GitHub存储库的URL - path：要获取的文件路径（例如“src/index.js”）

使用示例

以下是一些如何将这些工具与AI助手一起使用的示例：

1. 浏览存储库根目录:

让你的人工智能助手“向我展示存储库的内容https://github.com/Ryan0204/github-repo-mcp"

1. 探索特定目录:

询问“src目录中有哪些文件https://github.com/Ryan0204/github-repo-mcp?"

1. 查看文件:

询问“显示来自的README.md文件https://github.com/Ryan0204/github-repo-mcp"

局限性

• 速率限制：在没有身份验证的情况下，GitHub API有严格的速率限制（每小时60个请求）
• 私人存储库：除非提供具有适当权限的令牌，否则只能访问公共存储库
• 二进制文件：服务器检测到常见的二进制文件扩展名，不会显示其内容
• 大文件：GitHub API对可以检索的文件大小有限制

故障排除

以下是一些常见问题及其解决方案：

• 请求频率超限：按照配置部分所述设置GitHub令牌
• 未找到命令：确保该软件包已全局安装
• 连接错误：检查您的互联网连接和GitHub API状态

如果您遇到任何问题，请检查输出中的错误消息或在GitHub存储库中创建问题。

______________________________________________________________________

享受！ ☺️