What is Codebase Mcp Server

Codebase MCP Server is a Model Context Protocol server designed for secure and efficient analysis of codebases.

Use cases

Use cases include analyzing project dependencies, managing project files, retrieving project metadata, and ensuring secure file operations.

How to use

To use Codebase MCP Server, ensure you have Node.js v18 or later installed. Then, install the package via npm and follow the QuickStart guide to set up your project.

Key features

Key features include secure access to file operations, efficient file management tools, detailed metadata retrieval, and dependency analysis capabilities.

Where to use

Codebase MCP Server is suitable for software development environments, particularly for projects using JavaScript, TypeScript, and CSS.

Codebase MCP Server

Model Context Protocol server for secure and efficient Codebase analysis

Key Features • Supported Languages • Tools • QuickStart • Build • Contributing

🌟 Key Features

• Secure Access: Restricts file operations to predefined root directory.
• Efficient File Management: Provides tools for reading and searching files.
• Detailed Metadata: Retrieves comprehensive file metadata including size, creation time, last modified time, permissions, and type.
• Dependency Analysis: Traverses and analyzes dependency trees within projects.

📋 Supported Languages

• JavaScript/TypeScript
• CSS / CSS Preprocessors

🛠️ Tools

• get-project-basics: Retrieves essential project information including package.json details, directory structure.
• search-config-files: Searches for configuration files within the root directory and returns their paths.
• get-dependency-tree: Traverses the dependency tree based on the given file path and root directory, and returns the traversal results.
• list-directory: Lists the contents of a specified directory, distinguishing between files and directories.
• read-file-with-metadata: Reads the content of a specified file and retrieves its metadata.

🚀 QuickStart

Prerequisites

• Node.js v18 or later
• Codebase to communicate with LLM

Installation

First, install the Codebase MCP server with your client. A typical configuration looks like this:

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": [
        "codebase-mcp-server@latest",
        "/path/to/your/codebase"
      ]
    }
  }
}

Or, you can install the Codebase MCP server with Docker.

After cloning this repository, build the Docker image:

docker build -t mcp/codebase -f .

And then add the following to your MCP servers file:

{
  "mcpServers": {
    "Codebase": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "--mount",
        "type=bind,src=/path/to/your/codebase/dir,dst=/projects/path/to/your/codebase/dir,ro",
        "--mount",
        "type=bind,src=/path/to/some/file.txt,dst=/projects/path/to/some/file.txt",
        "mcp/codebase",
        "/projects"
      ]
    }
  }
}

# For VS Code
code --add-mcp '{"name":"Codebase","command":"npx","args":["codebase-mcp-server@latest"]}'

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": [
        "codebase-mcp-server@latest"
      ]
    }
  }
}

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": [
        "codebase-mcp-server@latest"
      ]
    }
  }
}

{
  "mcpServers": {
    "Codebase": {
      "command": "npx",
      "args": [
        "codebase-mcp-server@latest"
      ]
    }
  }
}

🔧 Build

Local Development Build

# Install dependencies
npm ci

# Build TypeScript
npm run build

Docker Build

# Build Docker image
docker build -t mcp/codebase -f .

# Or with specific tag
docker build -t mcp/codebase:latest -f .

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide for details on our Code of conduct and the process for submitting pull requests.