MCP GitHub Reader
2025.03.30
1
JavaScript代码分析GitHub 工具开发辅助开发效率
MCP GitHub Reader 是一个轻量级的 Model Context Protocol (MCP) 服务器，旨在为大型语言模型提供 GitHub 仓库的上下文信息。它通过 GitHub API 直接访问仓库内容，无需本地克隆，支持仓库分析、文件访问、智能过滤、缓存优化和搜索功能。
View on GitHub
Overview
基本能力
产品定位
MCP GitHub Reader 是一个专为大型语言模型设计的工具，用于从 GitHub 仓库中提取和分析代码及文档内容，帮助开发者更高效地理解和操作代码库。
核心功能
- API 访问：直接通过 GitHub API 访问仓库内容，无需本地克隆。
- 仓库分析：提供仓库的概览和统计信息。
- 文件访问：支持获取单个文件内容或整个仓库的文件结构。
- 智能过滤：通过 glob 和正则表达式模式过滤文件。
- 缓存优化：智能缓存和请求优化，避免 GitHub API 限制。
- 搜索功能：在仓库中搜索匹配特定模式的文件。
- MCP 兼容：支持任何支持 Model Context Protocol 的 LLM 客户端。
- 提示模板：提供常见仓库分析任务的现成提示模板。
适用场景
- 代码库分析和理解
- 文件内容检索和搜索
- 代码审查和文档生成
- 自动化开发流程
工具列表
- get_individual_file_content：获取特定文件内容。
- get_entire_repo_contents：获取整个仓库内容，支持过滤。
- analyzeRepository：分析仓库，提供统计和语言分类。
- searchRepository：在仓库中搜索匹配特定模式的文件。
常见问题解答
- 支持私有仓库吗？：目前仅支持公共 GitHub 仓库。
- 有 API 限制吗？：未认证请求每小时限制 60 次。
使用教程
使用依赖
确保已安装 Node.js 和 npm。
安装教程
全局安装（推荐 CLI 使用）
npm install -g mcp-github-reader
本地安装
npm install mcp-github-reader
调试方式
作为独立服务器运行
# 全局安装
mcp-github-reader
# 本地安装
npx mcp-github-reader
与 Claude 集成
npm 安装
在 Claude Desktop 工具配置中添加：
"github-reader": {
"runtime": "node",
"command": "npx",
"args": [
"-y",
"mcp-github-reader"
]
}
本地安装
"github-reader-test": {
"command": "node",
"args": [
"/path/to/your/repo/src/mcp-github-reader.js"
]
}
替换 /path/to/your/repo 为实际路径。