Codebase MCP

Model Context Protocol implementation for retrieving codebases using RepoMix

typescript

72

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "dedeveloper23-codebase-mcp": {
      "command": "codebase-mcp",
      "args": [
        "start"
      ]
    }
  }
}

Codebase MCP lets you retrieve and analyze an entire codebase in a single, readable output and even process remote repositories. It provides a convenient way to generate a comprehensive snapshot of your project for AI assistants, code reviews, or archival purposes.

How to use

You connect to the MCP server with a client and tell it what scope you want analyzed. You can analyze your current workspace to understand its structure, fetch and examine a public GitHub repository, or save a generated codebase snapshot for later use. Use the appropriate tool to perform the action you need, then review the resulting output in your preferred format (XML, Markdown, or Plain text). You can request a complete codebase readout or targeted summaries of files and components as needed.

How to install

Prerequisites: ensure you have Node.js and npm installed on your system.

Install the MCP CLI globally.

npm install -g codebase-mcp

Install RepoMix (required dependency) so the MCP can access codebases correctly.

codebase-mcp install

Additional usage notes

Start the MCP server locally to expose it to clients. The server runs in stdio mode and accepts the command you provide.

Starting the MCP server in stdio mode will allow any compatible client to connect and issue the available tools.

Configuration and examples

The MCP supports several workflows. You can analyze the current project, inspect a remote repository, or save a codebase snapshot for later use. Use descriptive prompts to guide the analysis and specify the desired output format to suit your review or sharing needs.

Available tools

getCodebase

Analyzes and retrieves the entire codebase of the current workspace or project, producing a comprehensive snapshot in your chosen format.

getRemoteCodebase

Fetches and analyzes a public GitHub repository, returning a complete codebase readout for review.

saveCodebase

Saves the generated codebase analysis to a file so you can share or review it later.