
MCP GitHub Repository Server

2024.12.06
4
JavaScriptGitHub 仓库访问代码浏览开发效率
MCP GitHub Repository Server 是一个基于 Model Context Protocol 的服务,专门用于访问和浏览 GitHub 仓库内容。该服务允许 AI 助手通过 URI 访问指定 GitHub 仓库中的文件,支持文件内容读取、目录列表浏览以及分支特定文件访问等功能。
View on GitHub
Overview
基本能力
产品定位
MCP GitHub Repository Server 是一个专门为 AI 助手设计的 GitHub 仓库内容访问服务,旨在提供便捷的代码和文件浏览功能。
核心功能
- 资源访问
- 通过 URI 访问 GitHub 仓库中的任何文件
- 列出仓库内容并导航目录
- 支持特定分支的文件访问
-
文件内容以纯文本形式提供
-
资源 URI
- 基础 URL 格式:
https://api.github.com/repos/{owner}/{repo}/contents/{path}
- 支持文件和目录
- 文件以
text/plain
MIME 类型提供 -
目录以
application/x-directory
MIME 类型提供 -
API 实现
ListResources
- 列出仓库中的文件和目录ReadResource
- 检索特定文件的内容
适用场景
- AI 助手需要访问和浏览 GitHub 仓库内容
- 开发者需要快速查看或分析 GitHub 仓库中的代码
- 需要自动化处理 GitHub 仓库内容的场景
工具列表
- MCP Inspector
- 用于调试 MCP 服务器
- 提供浏览器访问的调试工具
常见问题解答
- 认证问题
-
确保 GitHub 个人访问令牌具有访问仓库内容的适当权限
-
错误处理
-
服务器包含对缺失环境变量、GitHub API 错误、无效路径和认证失败的处理
-
安全注意事项
- 保持 GitHub 个人访问令牌的安全
- 考虑使用具有最小必需权限的令牌
- 注意访问大型仓库时的仓库大小限制
使用教程
使用依赖
- 安装 Node.js 环境
- 获取 GitHub 个人访问令牌
安装教程
- 克隆仓库
- 安装依赖
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"
}
}
}
调试方式
使用 MCP Inspector 进行调试:
npm run inspector
这将提供一个 URL,用于在浏览器中访问调试工具。