MCP GitHub Repository Server

基本能力

产品定位

MCP GitHub Repository Server 是一个专门用于访问 GitHub 仓库内容的 MCP 服务器，旨在为 AI 助手提供便捷的代码和文档访问能力。

核心功能

1. 资源访问
2. 通过 URI 访问 GitHub 仓库中的任何文件
3. 列出仓库内容并导航目录
4. 支持特定分支的文件访问

5. 文件内容以纯文本形式提供

6. 资源 URI

7. 基础 URL 格式: https://api.github.com/repos/{owner}/{repo}/contents/{path}
8. 支持文件和目录访问
9. 文件使用 text/plain MIME 类型

10. 目录使用 application/x-directory MIME 类型

11. API 实现

12. ListResources - 列出仓库中的文件和目录
13. ReadResource - 检索特定文件的内容

适用场景

1. AI 助手需要访问 GitHub 仓库中的代码或文档
2. 开发者需要快速浏览和检索 GitHub 仓库内容
3. 自动化工具需要集成 GitHub 仓库访问功能

工具列表

1. MCP Inspector
2. 用于调试 MCP 服务器通信

3. 提供浏览器访问的调试工具

4. GitHub API

5. 提供对 GitHub 仓库内容的访问能力

常见问题解答

1. 认证问题
2. 确保 GitHub 个人访问令牌具有适当的权限

3. 令牌需要存储在环境变量中

4. 错误处理

5. 服务器处理缺失环境变量、GitHub API 错误、无效路径等问题

6. 安全注意事项

7. 保持 GitHub 个人访问令牌安全
8. 考虑使用最小权限的令牌
9. 注意大型仓库的访问限制

使用教程

使用依赖

1. 安装 Node.js 环境
2. 获取 GitHub 个人访问令牌

安装教程

1. 安装依赖:

npm install

1. 构建服务器:

npm run build

1. 开发时自动重建:

npm run watch

1. 配置 Claude Desktop:

{
  "mcpServers": {
    "mcp-server-github-repo": {
      "command": "/path/to/mcp-server-github-repo/build/index.js"
    }
  }
}

调试方式

使用 MCP Inspector 进行调试:

npm run inspector

这将提供一个 URL 用于在浏览器中访问调试工具。

许可证

该项目遵循 MIT 开源许可条款，请参阅 MIT 了解完整条款。