Github Repository

🚀 GitHub 倉庫 MCP 服務器

GitHub Repo MCP 是一個開源的 MCP 服務器，它能讓您的人工智能助手瀏覽 GitHub 倉庫、探索目錄以及查看文件內容，為您的開發工作提供便利。

🚀 快速開始

先決條件

在系統上安裝服務器需要以下內容：

• Node.js 18+
• npm 或 yarn

第一步：安裝

您可以使用 Smithery、NPX 或在 IDE 的 mcp.json 中設置來安裝和運行 GitHub Repo MCP：

MacOS

npx github-repo-mcp

Windows NPX

cmd /c npx -y github-repo-mcp

Windows NPX 通過 mcp.json 設置

{
  "mcp": {
    "servers": [
      {
        "name": "GitHub Repo MCP",
        "executable": "github-repo-mcp",
        "args": []
      }
    ]
  }
}

第二步：配置

在 config.json 中添加以下內容：

{
  "repositories": [
    {
      "url": "https://github.com/Ryan0204/github-repo-mcp",
      "name": "GitHub Repo MCP"
    }
  ]
}

✨ 主要特性

• 💻 兼容 Cursor、Windsurf、Claude Desktop 和其他支持 stdio 協議的 MCP 客戶端
• 🔎 檢索任何公共 GitHub 倉庫的內容
• 📂 瀏覽倉庫目錄和子目錄
• 📝 查看代碼和文本文件的內容
• 📦 通過包管理器輕鬆安裝

📚 詳細文檔

工具和命令

1. listRepositories()

   • 列出所有已配置的倉庫

   listRepositories
   

2. getRepositoryContents(String url)

   • 顯示指定 URL 倉庫的內容

   getRepositoryContents https://github.com/Ryan0204/github-repo-mcp
   

3. getDirectoryContents(String url, String path)

   • 查看指定路徑下的文件和子目錄

   getDirectoryContents https://github.com/Ryan0204/github-repo-mcp src
   

4. getFileContents(String url, String path)

   • 顯示指定 URL 和路徑下文件的內容

   getFileContents https://github.com/Ryan0204/github-repo-mcp README.md
   

問題排除

如果遇到以下情況，請按照步驟操作：

• 無法連接到 GitHub API：

  • 檢查 Internet 連接和 GitHub 狀態
  • 嘗試重新運行命令

  npm start
  

• 找不到文件或目錄：

  • 確保路徑正確無誤
  • 查看倉庫的文件結構

• 超出速率限制：

  • 使用 GitHub 賬戶獲取令牌
  • 在 config.json 中添加令牌

通過以上步驟，您應該能夠順利地使用 GitHub Repo MCP 服務器。如果有任何其他問題，請查看輸出中的錯誤信息或在 GitHub 倉庫中創建問題。

祝您愉快！😊