Codebase Retrieval (RepoMix)

by dedeveloper23

15 stars

Not rated

GitHub

About

Integrates with RepoMix to enable codebase retrieval and analysis for tasks like code review, dependency tracking, and automated documentation generation.

Details

Author: dedeveloper23
Repository: DeDeveloper23/codebase-mcp
GitHub stars: 15
License: MIT License
Categories: Productivity, Developer Tools, Design, Workplace, File Management, AI, Frontend, Project Management, Knowledge Base, Infrastructure

- 📚 Codebase Retrieval: Retrieve the entire codebase as a single text output in different formats (XML, Markdown, Plain)
- 🌐 Remote Repository Support: Process remote GitHub repositories directly
- 💾 File Saving: Save the processed codebase to a file
- 🔧 Customizable Options: Control how the codebase is processed with various options (comments, line numbers, file summaries, etc.)

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below
Plugin Name Codebase Retrieval (RepoMix)

Command (node, npx, python, etc.) codebase-mcp
Arguments
- Argument 1 start
Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "start"
            ],
            "shell": false,
            "command": "codebase-mcp"
        }
    }
}

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "/c",
                "codebase-mcp",
                "start"
            ],
            "shell": false,
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "start"
            ],
            "shell": false,
            "command": "codebase-mcp"
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "start"
            ],
            "shell": false,
            "command": "codebase-mcp"
        }
    }
}

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "/c",
                "codebase-mcp",
                "start"
            ],
            "shell": false,
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "start"
            ],
            "shell": false,
            "command": "codebase-mcp"
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "start"
            ],
            "shell": false,
            "command": "codebase-mcp"
        }
    }
}

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "/c",
                "codebase-mcp",
                "start"
            ],
            "shell": false,
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "start"
            ],
            "shell": false,
            "command": "codebase-mcp"
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "start"
            ],
            "shell": false,
            "command": "codebase-mcp"
        }
    }
}

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "/c",
                "codebase-mcp",
                "start"
            ],
            "shell": false,
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "start"
            ],
            "shell": false,
            "command": "codebase-mcp"
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "start"
            ],
            "shell": false,
            "command": "codebase-mcp"
        }
    }
}

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "/c",
                "codebase-mcp",
                "start"
            ],
            "shell": false,
            "command": "cmd"
        }
    }
}

JSON

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "start"
            ],
            "shell": false,
            "command": "codebase-mcp"
        }
    }
}

From the repository

npm install -g codebase-mcp

codebase-mcp install

npm install npm install -g . Here are some example prompts you can use with the Composer Agent:

"Analyze my current project and explain its main components."

"Can you look at the tensorflow/tensorflow repository and explain how their testing framework works?"

"Save an analysis of my project to 'codebase-analysis.md' in markdown format."
```

The Composer Agent will automatically use the appropriate tool based on your request.

`getCodebase`

Analyzes your current workspace/project. Use when you want the AI to understand your entire codebase.

`getRemoteCodebase`

Fetches and analyzes any public GitHub repository. Use when you want to explore or understand other projects.

`saveCodebase`

Saves the codebase analysis to a file for later use. Use when you want to preserve the codebase snapshot or share it.

1. getCodebase
- Purpose: Analyzes your current workspace/project
- Use when: You want the AI to understand your entire codebase
- Example prompt: "Please analyze my codebase to understand its structure"

2. getRemoteCodebase
- Purpose: Fetches and analyzes any public GitHub repository
- Use when: You want to explore or understand other projects
- Example prompt: "Can you analyze the repository at github.com/username/repo?"

3. saveCodebase
- Purpose: Saves the codebase analysis to a file for later use
- Use when: You want to preserve the codebase snapshot or share it
- Example prompt: "Save an analysis of this codebase to review later"

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "codebase retrieval (repomix)": {
            "env": {},
            "args": [
                "start"
            ],
            "shell": false,
            "command": "codebase-mcp"
        }
    }
}

Linux

{
    "env": [],
    "args": [
        "start"
    ],
    "shell": false,
    "command": "codebase-mcp"
}

Macos

{
    "env": [],
    "args": [
        "start"
    ],
    "shell": false,
    "command": "codebase-mcp"
}

Windows

{
    "env": [],
    "args": [
        "/c",
        "codebase-mcp",
        "start"
    ],
    "shell": false,
    "command": "cmd"
}

# Codebase MCP A [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server implementation that provides tools to retrieve and analyze entire codebases using [RepoMix](https://repomix.com/). This MCP allows AI Agents like Cursor's Composer Agent to automatically read and understand entire codebases at once, making it easier for developers to work with large codebases and for AI assistants to have comprehensive context of a project. ## Features - 📚 **Codebase Retrieval**: Retrieve the entire codebase as a single text output in different formats (XML, Markdown, Plain) - 🌐 **Remote Repository Support**: Process remote GitHub repositories directly - 💾 **File Saving**: Save the processed codebase to a file - 🔧 **Customizable Options**: Control how the codebase is processed with various options (comments, line numbers, file summaries, etc.) ## Installation ### From NPM (Recommended) ```bash # Install the package globally npm install -g codebase-mcp # Install RepoMix (required dependency) codebase-mcp install ``` ### From GitHub ```bash # Clone the repository git clone https://github.com/DeDeveloper23/codebase-mcp.git # Navigate to the project directory cd codebase-mcp # Install dependencies npm install # Build the project npm run build # Install globally npm install -g . # Install RepoMix (required dependency) codebase-mcp install ``` ## Integration with Cursor To use this MCP with Cursor's Composer Agent: 1. Open Cursor IDE 2. Click the Composer icon in the sidebar 3. Click the "MCP Servers" button at the top 4. Click "Add new MCP server" 5. Fill in the details: - Name: `Codebase MCP` (or any name you prefer) - Type: `command` - Command: `codebase-mcp start` 6. Click "Add" to save Once added, the MCP will provide three powerful tools to the Composer Agent: ### Available Tools 1. **getCodebase** - Purpose: Analyzes your current workspace/project - Use when: You want the AI to understand your entire codebase - Example prompt: "Please analyze my codebase to understand its structure" 2. **getRemoteCodebase** - Purpose: Fetches and analyzes any public GitHub repository - Use when: You want to explore or understand other projects - Example prompt: "Can you analyze the repository at github.com/username/repo?" 3. **saveCodebase** - Purpose: Saves the codebase analysis to a file for later use - Use when: You want to preserve the codebase snapshot or share it - Example prompt: "Save an analysis of this codebase to review later" ### Example Usage in Cursor Here are some example prompts you can use with the Composer Agent: ``` "Analyze my current project and explain its main components." "Can you look at the tensorflow/tensorflow repository and explain how their testing framework works?" "Save an analysis of my project to 'codebase-analysis.md' in markdown format." ``` The Composer Agent will automatically use the appropriate tool based on your request. ## Usage Outside Cursor ### Starting the MCP Server ```bash codebase-mcp start ``` This will start the MCP server in stdio mode, which can be used by any MCP-compatible clients. ## License MIT

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

getCodebase

getRemoteCodebase

saveCodebase

Claude Desktop / Cursor

Linux

Macos

Windows

Install

More like this

Time

Sentry

Github

Git

GitLab

Context 7

`getCodebase`

`getRemoteCodebase`

`saveCodebase`