GitHub 探索器 MCP 服务器

该MCP（中间件协议）服务器提供GitHub仓库信息，包括文件内容、目录结构和其他元数据，供像Claude Desktop、Cursor等客户端使用。

功能

• 仓库摘要：获取GitHub仓库的全面信息
• 目录结构：查看任何仓库的完整文件结构，并以ASCII树状图形式呈现
• 文件内容：访问特定文件的内容
• 元数据增强：获取 stars、forks、描述和最后更新时间等信息
• 本地仓库克隆：本地克隆仓库以便更快处理和更全面的数据
• 缓存系统：高效缓存仓库数据以减少API调用次数
• 进度通知：长时间操作的更新状态
• 格式选项：以文本或结构化JSON格式获取数据
• 自动完成：提供仓库所有者和名称的建议
• Web界面：在HTTP模式下运行时提供基本状态页面和信息

安装

使用NPM

# 从npm安装
npm install @trishchuk/github-explorer-mcp -g

# 运行服务器（MCP客户端的stdio模式）
github-explorer-mcp

# 或者在HTTP/SSE模式下运行
github-explorer-mcp-sse

使用Docker

# 构建Docker镜像
docker build -t github-explorer-mcp .

# 运行容器
docker run -p 3000:3000 github-explorer-mcp

与MCP客户端一起使用

Claude Desktop

在Claude Desktop配置中添加：

{
  "mcpServers": {
    "github-explorer": {
      "command": "npx",
      "args": ["-y", "@trishchuk/github-explorer-mcp"]
    }
  }
}

Cursor

在Cursor配置中添加：

{
  "mcpServers": {
    "github-explorer": {
      "command": "npx",
      "args": ["-y", "@trishchuk/github-explorer-mcp"]
    }
  }
}

API 参考

MCP服务器提供以下工具：

github_repository_summary

获取GitHub仓库的摘要信息。

{
  owner: string;    // GitHub组织或用户名
  repo: string;     // 仓库名称
  branch?: string;  // 可选分支名称
  includeMetadata?: boolean; // 是否包含stars、forks等元数据
}

github_directory_structure

获取GitHub仓库的目录结构。

{
  owner: string;    // GitHub组织或用户名
  repo: string;     // 仓库名称
  branch?: string;  // 可选分支名称
}

github_file_content

获取GitHub仓库中文件的内容。

{
  owner: string;    // GitHub组织或用户名
  repo: string;     // 仓库名称
  file_path: string; // 文件路径
  branch?: string;  // 可选分支名称
}

开发

克隆仓库

使用以下命令克隆项目：

git clone https://github.com/yourusername/github-explorer-mcp.git
cd github-explorer-mcp

安装依赖

安装项目所需的依赖项：

npm install

运行

运行项目：

npm start

故障排除

Node.js 版本问题

确保使用Node.js 18或更高版本。如果出现问题，请检查并升级Node.js。

Docker 部署问题

如果在Docker部署时遇到问题，请确认镜像是否正确构建，并且容器配置无误。

贡献

欢迎提交Pull Request，帮助改进此项目！