MCP GitHub 读者

一个轻量级的模型上下文协议（MCP）服务器，用于将GitHub仓库带入大型语言模型的上下文中。

功能

• 基于API：无需本地克隆仓库 - 直接与GitHub API交互
• 仓库分析：获取任何GitHub仓库的概述和统计信息
• 文件访问：检索单个文件内容或整个仓库文件结构
• 智能过滤：使用通配符和正则表达式包含或排除文件
• 缓存支持：智能缓存和优化请求模式以避免GitHub API限制
• 搜索功能：查找匹配特定模式的文件
• MCP兼容：与任何支持模型上下文协议的LLM客户端兼容
• 提示模板：用于常见仓库分析任务的现成提示模板

安装

全局安装（推荐用于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替换为实际仓库路径。

可用工具

MCP服务器提供了四个强大的工具来与GitHub仓库交互：

1. 获取单个文件内容

从GitHub仓库中检索特定文件的内容。

参数：

• owner：仓库所有者（例如，“skydeckai”）
• repo：仓库名称（例如，“mcp-server-aidd”）
• path：仓库中的文件路径（例如，“README.md”）
• branch（可选）：分支名

2. 获取整个仓库内容

从指定仓库中检索符合特定模式的所有文件。

参数：

• owner：仓库所有者
• repo：仓库名称
• include_patterns：包含的文件模式列表
• exclude_patterns：排除的文件模式列表
• max_files：要返回的最大文件数

3. 分析仓库

分析指定仓库并返回详细报告。

参数：

• repository：要分析的仓库（格式为“owner/repo”）
• include_files：是否包括文件内容

4. 搜索文件

在指定仓库中搜索符合特定查询的文件。

参数：

• repository：要搜索的仓库
• query：搜索查询
• file_type：文件类型（可选）

示例

获取单个文件内容

{
  "name": "get_individual_file_content",
  "parameters": {
    "owner": "skydeckai",
    "repo": "mcp-server-aidd",
    "path": "README.md"
  }
}

获取整个仓库内容

{
  "name": "get_entire_repo_contents",
  "parameters": {
    "owner": "skydeckai",
    "repo": "mcp-server-aidd",
    "include_patterns": ["*.js", "*.json", "*.md"],
    "exclude_patterns": ["*.test.js", "node_modules/*"],
    "max_files": 30
  }
}

分析仓库

{
  "name": "analyze_repository",
  "parameters": {
    "repository": "skydeckai/mcp-server-aidd",
    "include_files": true
  }
}

局限性

• 目前仅支持公共GitHub仓库
• 不支持私人仓库或身份验证
• 受限于GitHub API速率限制（未认证请求每小时60次）

许可证

Apache License 2.0。更多详细信息请参阅LICENSE文件。

版权所有 © 2025 SkyDeck AI Inc.