Code Scope

Overview

Code Index MCP is a Model Context Protocol server that bridges the gap between AI models and complex codebases. It provides intelligent indexing, advanced search capabilities, and detailed code analysis to help AI assistants understand and navigate your projects effectively.

Perfect for: Code review, refactoring, documentation generation, debugging assistance, and architectural analysis.

Key Features

🔍 Intelligent Search & Analysis

• Advanced Search: Auto-detects and uses the best available tool (ugrep, ripgrep, ag, or grep)
• Regex Support: Full regex pattern matching with ReDoS attack prevention
• Fuzzy Search: True fuzzy matching with edit distance (ugrep) or word boundary patterns
• File Analysis: Deep insights into structure, imports, classes, methods, and complexity metrics

🗂️ Multi-Language Support

• Mainstream Languages: Java, Python, JavaScript/TypeScript, C/C++, Go, Rust, C#
• Mobile Development: Swift, Kotlin, Objective-C/C++, React Native
• Web Frontend: Vue, React, Svelte, Astro, HTML, CSS, SCSS
• Database: SQL (MySQL, PostgreSQL, SQLite), NoSQL, stored procedures, migrations
• Scripting: Ruby, PHP, Shell, PowerShell, Bash
• Systems: C/C++, Rust, Go, Zig
• JVM Ecosystem: Java, Kotlin, Scala, Groovy
• Others: Lua, Perl, R, MATLAB, configuration files
• 50+ File Types Total - View complete list

⚡ Real-time Monitoring & Auto-refresh

• File Watcher: Automatic index updates when files change
• Cross-platform: Native OS file system monitoring (inotify, FSEvents, ReadDirectoryChangesW)
• Smart Debouncing: Batches rapid changes to prevent excessive rebuilds (default: 6 seconds)
• Thread-safe: Non-blocking background operations with ThreadPoolExecutor

⚡ Performance & Efficiency

• Smart Indexing: Recursively scans with intelligent filtering of build directories
• Persistent Caching: Stores indexes for lightning-fast subsequent access
• Lazy Loading: Tools detected only when needed for optimal startup
• Memory Efficient: Intelligent caching strategies for large codebases

Supported File Types

Quick Start

🚀 Recommended Setup (Most Users)

The easiest way to get started with any MCP-compatible application:

Prerequisites: Python 3.10+ and uv

1. Add to your MCP configuration (e.g., claude_desktop_config.json or ~/.claude.json):

   {
     "mcpServers": {
       "code-index": {
         "command": "uvx",
         "args": ["code-index-mcp"]
       }
     }
   }
   

2. Restart your application – uvx automatically handles installation and execution

🛠️ Development Setup

For contributing or local development:

1. Clone and install:

   git clone https://github.com/johnhuang316/code-index-mcp.git
   cd code-index-mcp
   uv sync
   

2. Configure for local development:

   {
     "mcpServers": {
       "code-index": {
         "command": "uv",
         "args": ["run", "code-index-mcp"]
       }
     }
   }
   

3. Debug with MCP Inspector:

   npx @modelcontextprotocol/inspector uv run code-index-mcp
   

pip install code-index-mcp

{
  "mcpServers": {
    "code-index": {
      "command": "code-index-mcp",
      "args": []
    }
  }
}

Available Tools

🏗️ Project Management

🔍 Search & Discovery

🔄 Monitoring & Auto-refresh

🛠️ System & Maintenance

Usage Examples

🎯 Quick Start Workflow

1. Initialize Your Project

Set the project path to /Users/dev/my-react-app

Automatically indexes your codebase and creates searchable cache

2. Explore Project Structure

Find all TypeScript component files in src/components

Uses: find_files with pattern src/components/**/*.tsx

3. Analyze Key Files

Give me a summary of src/api/userService.ts

Uses: get_file_summary to show functions, imports, and complexity

🔍 Advanced Search Examples

Search for all function calls matching "get.*Data" using regex

Find authentication-related functions with fuzzy search for 'authUser'

Search for "API_ENDPOINT" only in Python files

Configure automatic index updates when files change

I added new components, please refresh the project index

Troubleshooting

🔄 Auto-refresh Not Working

If automatic index updates aren't working when files change, try:

• pip install watchdog (may resolve environment isolation issues)
• Use manual refresh: Call the refresh_index tool after making file changes
• Check file watcher status: Use get_file_watcher_status to verify monitoring is active

Development & Contributing

🔧 Building from Source

git clone https://github.com/johnhuang316/code-index-mcp.git
cd code-index-mcp
uv sync
uv run code-index-mcp

🐛 Debugging

npx @modelcontextprotocol/inspector uvx code-index-mcp

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📜 License

MIT License

🌐 Translations

• 繁體中文
• 日本語