JinDaGe - github-explorer-mcp MCP Details

article

README

🚀 GitHub探索器MCP服务器

GitHub探索器MCP服务器借助MCP（中间件协议），为Claude Desktop、Cursor等客户端提供GitHub仓库的各类信息，涵盖文件内容、目录结构以及其他元数据，助力客户端更高效地使用GitHub仓库资源。

🚀 快速开始

本服务器可提供丰富的GitHub仓库信息，支持多种使用模式和客户端配置，能有效满足不同场景下对仓库数据的获取需求。

✨ 主要特性

仓库摘要：全面获取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，帮助改进此项目！

github-explorer-mcp