MCP Git Repo Browser

What is mcp-git-repo-browser?

mcp-git-repo-browser is a powerful tool developed by razorback16 that allows users to interact with Git repositories through a Node.js-based server. This server leverages the Model Context Protocol (MCP), which facilitates secure and efficient connections between AI systems and various data sources. The mcp-git-repo-browser acts as a bridge, enabling users to browse and access the contents of Git repositories in a structured and user-friendly manner.

How to Use mcp-git-repo-browser

To get started with mcp-git-repo-browser, you need to set up your MCP environment by configuring your settings file. Here’s a straightforward way to include the server in your MCP configuration:

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

Once configured, you can install and run the server by following these steps:

1. Installation:

   • Clone the repository to your local machine.
   • Navigate to the mcp-git-repo-browser directory.
   • Run the command npm install to install necessary dependencies.

2. Starting the Server:

   • Execute node src/index.js to start the server.
   • The server operates via the standard input/output interface, making it compatible with MCP clients.

Key Features of mcp-git-repo-browser

mcp-git-repo-browser offers two primary tools to enhance your interaction with Git repositories:

1. git_directory_structure:

   • Purpose: Provides a visual representation of a repository's directory structure.
   • Input: Repository URL.
   • Output: An ASCII tree that visually outlines the directory hierarchy, making it easy to understand the layout of files and folders.

2. git_read_important_files:

   • Purpose: Accesses and returns the content of specific files within a repository.
   • Input: Repository URL and a list of file paths.
   • Output: A dictionary mapping each file path to its respective content, allowing for quick retrieval of important information.

Implementation Details:

• Utilizes native Node.js modules such as crypto, path, and os for core operations.
• Employs fs-extra for enhanced file handling and simple-git for seamless Git operations.
• Features robust error handling and resource management, ensuring smooth operation.
• Optimizes performance by creating deterministic temporary directories and reusing cloned repositories.

Requirements:

• Ensure Node.js version 14.x or higher is installed.
• Git must be present on your system for repository operations.

License: The mcp-git-repo-browser is distributed under the MIT License, allowing for flexible use and modification.

With these features and straightforward setup, mcp-git-repo-browser provides an efficient solution for exploring and interacting with Git repositories, enhancing your productivity and streamlining your workflow.