Codebase MCP

🚀 Codebase MCP

A server implementation of the Model Context Protocol (MCP), providing tools to retrieve and analyze entire codebases using RepoMix.

This MCP allows AI agents like Cursor's Composer Agent to automatically read and understand an entire codebase at once, making it easier for developers to handle large codebases and enabling AI assistants to have comprehensive context about the project.

✨ Features

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

📦 Installation

From NPM (Recommended)

# Install the package globally
npm install -g codebase-mcp

# Install RepoMix (required dependency)
codebase-mcp install

From GitHub

# 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 the Cursor IDE.
2. Click the Composer icon in the sidebar.
3. Click the "MCP Server" button at the top.
4. Click "Add New MCP Server".
5. Fill in the details:
   • Name: Codebase MCP (or any other name).
   • Type: command
   • Command: codebase-mcp start
6. Click "Add" to save.

Once added, the MCP will provide three powerful tools for the Composer Agent:

Available Tools

1. getCodebase

   • Purpose: Analyze your current workspace/project.
   • Usage: When you want the AI to understand the entire codebase.
   • Example Prompt: "Please analyze my codebase to understand its structure."

2. getRemoteCodebase

   • Purpose: Retrieve and analyze any public GitHub repository.
   • Usage: When you want to explore or understand other projects.
   • Example Prompt: "Can you analyze the github.com/username/repo repository?"

3. saveCodebase

   • Purpose: Save the codebase analysis to a file for later use.
   • Usage: When you want to preserve a snapshot of the codebase or share it.
   • Example Prompt: "Save the analysis of this codebase as a Markdown file named 'codebase-analysis.md'."

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 the analysis of this project to a file named 'codebase-analysis.md'."

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

💻 Usage Outside of Cursor

Start the MCP Server

codebase-mcp start

This will start the MCP server running in standard input/output mode, which can be used by any compatible MCP client.

📄 License

MIT