MCP GitHub Repository Server

MCP GitHub 仓库服务

一个可访问 GitHub 仓库内容的 MCP（Model Context Protocol）服务。此服务允许 AI 助手浏览和读取指定 GitHub 仓库中的文件。

演示

功能

资源

• 通过 URI 访问 GitHub 仓库中的任意文件
• 列出仓库内容并浏览目录
• 支持访问特定分支中的文件
• 文件内容以纯文本形式提供

资源 URI

• 基础 URL 格式：https://api.github.com/repos/{owner}/{repo}/contents/{path}
• 支持文件和目录
• 文件以 text/plain MIME 类型提供
• 目录以 application/x-directory MIME 类型提供

配置

服务需要以下环境变量：

GITHUB_PERSONAL_ACCESS_TOKEN=your_github_token
GITHUB_OWNER=repository_owner
GITHUB_REPO=repository_name
GITHUB_BRANCH=branch_name  # Optional

开发

安装依赖：

npm install

构建服务：

npm run build

启用自动重新构建进行开发：

npm run watch

安装

若要与 Claude Desktop 搭配使用，请添加服务配置：

配置位置

• MacOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%/Claude/claude_desktop_config.json

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

API 实现

此服务实现了三个主要的 MCP 端点：

1. ListResources - 列出仓库中的文件和目录
2. ReadResource - 获取指定文件的内容

身份验证

此服务使用 GitHub Personal Access Token 进行身份验证。请确保令牌拥有访问仓库内容的适当权限。

错误处理

此服务针对以下情况提供错误处理：

• 缺少环境变量
• GitHub API 错误
• 无效路径（例如，尝试将目录作为文件读取）
• 身份验证失败

调试

由于 MCP 服务通过标准输入输出（stdio）通信，调试可能颇具挑战。请使用 MCP Inspector 进行调试：

npm run inspector

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

安全注意事项

• 妥善保管 GitHub Personal Access Token
• 考虑使用仅具备所需最低权限的令牌
• 访问大型仓库时，请注意仓库大小限制

许可证

MIT