Github Repository

🚀 GitHub Repo MCP Server

GitHub Repo MCP is an open - source MCP server that enables your AI assistant to browse GitHub repositories, explore directories, and view file contents.

📑 Table of Contents

• 🚀 Quick Start
• ✨ Features

✨ Features

• 💻 Compatible with Cursor, Windsurf, Claude Desktop, and other MCP clients supporting the stdio protocol.
• 🔎 Inspect the contents of any public GitHub repository.
• 📂 Browse repository directories and sub - directories.
• 📝 View the contents of code and text files.
• 📦 Easily install via a package manager.

🚀 Quick Start

Prerequisites

To install the server on your system, you need the following:

• Node.js 18+
• npm or yarn

Step 1: Installation

You can install and run GitHub Repo MCP using Smithery, NPX, or by setting it up in your IDE's mcp.json:

MacOS

npx github-repo-mcp

Windows NPX

cmd /c npx -y github-repo-mcp

Windows NPX via mcp.json Setup

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

Step 2: Configuration

Add the following to your config.json:

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

📚 Documentation

Tools and Commands

1. listRepositories()

   • List all configured repositories.

   listRepositories
   

2. getRepositoryContents(String url)

   • Display the contents of the specified URL repository.

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

3. getDirectoryContents(String url, String path)

   • View files and sub - directories under the specified path.

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

4. getFileContents(String url, String path)

   • Display the contents of the file at the specified URL and path.

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

🔧 Troubleshooting

If you encounter the following situations, follow these steps:

• Unable to connect to the GitHub API:

  • Check your Internet connection and GitHub status.
  • Try re - running the command.

  npm start
  

• File or directory not found:

  • Ensure the path is correct.
  • Check the repository's file structure.

• Rate limit exceeded:

  • Obtain a token using your GitHub account.
  • Add the token to your config.json.

By following these steps, you should be able to use the GitHub Repo MCP server smoothly. If you have any other issues, check the error messages in the output or create an issue in the GitHub repository.

Have a great time! 😊