Github Explorer MCP

🚀 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，幫助改進此項目！