Git Repo Browser

🚀 MCP Git Repository Browser (Node.js)

A Git repository browser implemented in Node.js using the Model Context Protocol (MCP). It provides an efficient way to explore Git repositories.

🚀 Quick Start

The server runs through standard input and output, making it compatible with MCP clients. To start the server, use the following command:

node src/index.js

✨ Features

The server offers two main tools:

1. git_directory_structure: Returns a tree-like representation of the repository's directory structure.

   • Input: Repository URL
   • Output: An ASCII tree showing the repository's directory structure

2. git_read_important_files: Reads and returns the contents of specified files.

   • Input: Repository URL and a list of file paths
   • Output: A dictionary mapping file paths to their contents

📦 Installation

git clone <repository-url>
cd mcp-git-repo-browser
npm install

💻 Usage Examples

Basic Usage

To start the server, run the following command:

node src/index.js

Advanced Usage

The server is designed to be used with MCP clients. You can integrate it into your existing MCP setup by following the configuration steps below.

📚 Documentation

Configuration

Add the following content to your MCP settings configuration file:

{
    "mcpServers": {
        "mcp-git-repo-browser": {
            "command": "node",
            "args": ["/path/to/mcp-git-repo-browser/src/index.js"]
        }
    }
}

Requirements

• Node.js 14.x or higher
• Git installed on the system

🔧 Technical Details

• Implements core functionality using Node.js native modules (crypto, path, os).
• Utilizes fs-extra for enhanced file operations.
• Employs simple-git for Git repository operations.
• Implements clean error handling and resource cleanup.
• Creates deterministic temporary directories based on the hash of the repository URL.
• Reuses cloned repositories whenever possible to improve efficiency.

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.