Code Index MCP

🚀 Code Index MCP

A Model Context Protocol (MCP) server for code indexing, searching, and analysis.

🚀 Quick Start

Code Index MCP is a server specifically designed for the MCP protocol, offering intelligent code indexing and analysis capabilities. It enables large language models to interact with your code repositories, providing real - time insights and navigation within the codebase.

This server is integrated into the Model Context Protocol (MCP), a standard approach for allowing AI models to interact with external tools and data sources.

✨ Features

• Project Indexing: Recursively scan directories to build a searchable index of code files.
• Code Search: Find patterns, function definitions, and references in the codebase.
• File Analysis: Obtain detailed information such as file structure, imports, and complexity.
• Intelligent Filtering: Automatically ignore build directories, dependencies, and non - code files.
• Persistent Storage: Cache the index to improve cross - session performance.

📦 Supported File Types

The server supports a variety of programming languages and file extensions, including:

• Python (.py)
• JavaScript/TypeScript (.js, .ts, .jsx, .tsx)
• Java (.java)
• C/C++ (.c, .cpp, .h, .hpp)
• C# (.cs)
• Go (.go)
• Ruby (.rb)
• PHP (.php)
• Swift (.swift)
• Kotlin (.kt)
• Rust (.rs)
• Scala (.scala)
• Shell scripts (.sh, .bash)
• Web files (.html, .css, .scss)
• Documentation/Configuration (.md, .json, .xml, .yml, .yaml)

📦 Installation

Prerequisites

• Python 3.8 or higher
• uv package manager (recommended)

Using uvx (Recommended)

The easiest way to install and run Code Index MCP is using uvx:

uvx code-index-mcp

Using pip

Alternatively, you can install it via pip:

pip install code-index-mcp

After installation, you can run it as a module:

python -m code_index_mcp

💻 Usage Examples

Integrating with Claude Desktop

Add the following to your Claude settings (~/Library/Application Support/Claude/setting.json):

{
  "codeIndexMCP": {
    "enabled": true,
    "path": "/usr/local/bin/uvx"
  }
}

Available Tools

• Set Project Path: Specify the root directory of the project to be indexed.
• Search Code: Find specific code patterns or functions in the project.
• Analyze File: Obtain relevant metadata and structural information of the file.
• Filter Results: Filter the indexed results according to your needs.
• Cache Management: Maintain and update the index to ensure efficient performance.

📚 Documentation

To contribute to this project, please refer to the Developer Documentation.

🌐 Languages

• Traditional Chinese

📄 License

This project is licensed under the MIT License.