@@ -22,36 +22,69 @@ Code Index MCP is a [Model Context Protocol](https://modelcontextprotocol.io) se
22
22
23
23
** Perfect for:** Code review, refactoring, documentation generation, debugging assistance, and architectural analysis.
24
24
25
+ ## Quick Start
26
+
27
+ ### 🚀 ** Recommended Setup (Most Users)**
28
+
29
+ The easiest way to get started with any MCP-compatible application:
30
+
31
+ ** Prerequisites:** Python 3.10+ and [ uv] ( https://github.com/astral-sh/uv )
32
+
33
+ 1 . ** Add to your MCP configuration** (e.g., ` claude_desktop_config.json ` or ` ~/.claude.json ` ):
34
+ ``` json
35
+ {
36
+ "mcpServers" : {
37
+ "code-index" : {
38
+ "command" : " uvx" ,
39
+ "args" : [" code-index-mcp" ]
40
+ }
41
+ }
42
+ }
43
+ ```
44
+
45
+ 2 . ** Restart your application** – ` uvx ` automatically handles installation and execution
46
+
47
+ 3 . ** Start using** :
48
+ ```
49
+ Set the project path to /Users/dev/my-react-app
50
+ Find all TypeScript files in this project
51
+ Search for "authentication" functions
52
+ Analyze the main App.tsx file
53
+ ```
54
+
55
+ ## Typical Use Cases
56
+
57
+ ** Code Review** : "Find all places using the old API"
58
+ ** Refactoring Help** : "Where is this function called?"
59
+ ** Learning Projects** : "Show me the main components of this React project"
60
+ ** Debugging** : "Search for all error handling related code"
61
+
25
62
## Key Features
26
63
27
64
### 🔍 ** Intelligent Search & Analysis**
65
+ - ** SCIP-Powered** : Industry-standard code intelligence format used by major IDEs
28
66
- ** Advanced Search** : Auto-detects and uses the best available tool (ugrep, ripgrep, ag, or grep)
29
- - ** Regex Support** : Full regex pattern matching with ReDoS attack prevention
30
- - ** Fuzzy Search** : True fuzzy matching with edit distance (ugrep) or word boundary patterns
67
+ - ** Universal Understanding** : Single system comprehends all programming languages
31
68
- ** File Analysis** : Deep insights into structure, imports, classes, methods, and complexity metrics
32
69
33
- ### 🗂️ ** Multi-Language Support**
34
- - ** Mainstream Languages** : Java, Python, JavaScript/TypeScript, C/C++, Go, Rust, C#
35
- - ** Mobile Development** : Swift, Kotlin, Objective-C/C++, React Native
36
- - ** Web Frontend** : Vue, React, Svelte, Astro, HTML, CSS, SCSS
37
- - ** Database** : SQL (MySQL, PostgreSQL, SQLite), NoSQL, stored procedures, migrations
38
- - ** Scripting** : Ruby, PHP, Shell, PowerShell, Bash
39
- - ** Systems** : C/C++, Rust, Go, Zig
40
- - ** JVM Ecosystem** : Java, Kotlin, Scala, Groovy
41
- - ** Others** : Lua, Perl, R, MATLAB, configuration files
42
- - ** 50+ File Types Total** - [ View complete list] ( #supported-file-types )
70
+ ### 🗂️ ** Multi-Language Support**
71
+ - ** 50+ File Types** : Java, Python, JavaScript/TypeScript, C/C++, Go, Rust, C#, Swift, Kotlin, Ruby, PHP, and more
72
+ - ** Web Frontend** : Vue, React, Svelte, HTML, CSS, SCSS
73
+ - ** Database** : SQL variants, NoSQL, stored procedures, migrations
74
+ - ** Configuration** : JSON, YAML, XML, Markdown
75
+ - ** [ View complete list] ( #supported-file-types ) **
43
76
44
77
### ⚡ ** Real-time Monitoring & Auto-refresh**
45
78
- ** File Watcher** : Automatic index updates when files change
46
- - ** Cross-platform** : Native OS file system monitoring (inotify, FSEvents, ReadDirectoryChangesW)
47
- - ** Smart Debouncing ** : Batches rapid changes to prevent excessive rebuilds (default: 6 seconds)
48
- - ** Thread-safe ** : Non-blocking background operations with ThreadPoolExecutor
79
+ - ** Cross-platform** : Native OS file system monitoring
80
+ - ** Smart Processing ** : Batches rapid changes to prevent excessive rebuilds
81
+ - ** Rich Metadata ** : Captures symbols, references, definitions, and relationships
49
82
50
83
### ⚡ ** Performance & Efficiency**
51
- - ** Smart Indexing** : Recursively scans with intelligent filtering of build directories
84
+ - ** SCIP Indexing** : Fast protobuf-based unified indexing system
52
85
- ** Persistent Caching** : Stores indexes for lightning-fast subsequent access
53
- - ** Lazy Loading ** : Tools detected only when needed for optimal startup
54
- - ** Memory Efficient** : Intelligent caching strategies for large codebases
86
+ - ** Smart Filtering ** : Intelligent exclusion of build directories and temporary files
87
+ - ** Memory Efficient** : Optimized for large codebases
55
88
56
89
## Supported File Types
57
90
@@ -128,28 +161,6 @@ Code Index MCP is a [Model Context Protocol](https://modelcontextprotocol.io) se
128
161
129
162
</details >
130
163
131
- ## Quick Start
132
-
133
- ### 🚀 ** Recommended Setup (Most Users)**
134
-
135
- The easiest way to get started with any MCP-compatible application:
136
-
137
- ** Prerequisites:** Python 3.10+ and [ uv] ( https://github.com/astral-sh/uv )
138
-
139
- 1 . ** Add to your MCP configuration** (e.g., ` claude_desktop_config.json ` or ` ~/.claude.json ` ):
140
- ``` json
141
- {
142
- "mcpServers" : {
143
- "code-index" : {
144
- "command" : " uvx" ,
145
- "args" : [" code-index-mcp" ]
146
- }
147
- }
148
- }
149
- ```
150
-
151
- 2 . ** Restart your application** – ` uvx ` automatically handles installation and execution
152
-
153
164
### 🛠️ ** Development Setup**
154
165
155
166
For contributing or local development:
0 commit comments