Skip to content

Commit 49306fc

Browse files
committed
chore: update README files for multilingual support
1 parent 263aa64 commit 49306fc

File tree

3 files changed

+145
-68
lines changed

3 files changed

+145
-68
lines changed

README.md

Lines changed: 51 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -22,36 +22,69 @@ Code Index MCP is a [Model Context Protocol](https://modelcontextprotocol.io) se
2222

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

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+
2562
## Key Features
2663

2764
### 🔍 **Intelligent Search & Analysis**
65+
- **SCIP-Powered**: Industry-standard code intelligence format used by major IDEs
2866
- **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
3168
- **File Analysis**: Deep insights into structure, imports, classes, methods, and complexity metrics
3269

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)**
4376

4477
### **Real-time Monitoring & Auto-refresh**
4578
- **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
4982

5083
### **Performance & Efficiency**
51-
- **Smart Indexing**: Recursively scans with intelligent filtering of build directories
84+
- **SCIP Indexing**: Fast protobuf-based unified indexing system
5285
- **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
5588

5689
## Supported File Types
5790

@@ -128,28 +161,6 @@ Code Index MCP is a [Model Context Protocol](https://modelcontextprotocol.io) se
128161

129162
</details>
130163

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-
153164
### 🛠️ **Development Setup**
154165

155166
For contributing or local development:

README_ja.md

Lines changed: 47 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,30 +22,63 @@ Code Index MCPは、AIモデルと複雑なコードベースの橋渡しをす
2222

2323
**最適な用途:**コードレビュー、リファクタリング、ドキュメント生成、デバッグ支援、アーキテクチャ解析。
2424

25+
## クイックスタート
26+
27+
### 🚀 **推奨セットアップ(ほとんどのユーザー)**
28+
29+
任意MCP対応アプリケーションで開始する最も簡単な方法:
30+
31+
**前提条件:** Python 3.10+ および [uv](https://github.com/astral-sh/uv)
32+
33+
1. **MCP設定に追加** (例:`claude_desktop_config.json` または `~/.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. **アプリケーションを再起動**`uvx`がインストールと実行を自動処理
46+
47+
3. **使用開始**
48+
```
49+
プロジェクトパスを/Users/dev/my-react-appに設定
50+
このプロジェクトのすべてのTypeScriptファイルを検索
51+
「authentication」関連関数を検索
52+
メインのApp.tsxファイルを解析
53+
```
54+
55+
## 一般的な使用ケース
56+
57+
**コードレビュー**:「旧いAPIを使用しているすべての箇所を検索」
58+
**リファクタリング支援**:「この関数はどこで呼ばれている?」
59+
**プロジェクト学習**:「このReactプロジェクトの主要コンポーネントを表示」
60+
**デバッグ支援**:「エラーハンドリング関連のコードをすべて検索」
61+
2562
## 主な機能
2663

2764
### 🔍 **インテリジェント検索・解析**
65+
- **SCIPパワー**:主要IDEで使用される業界標準コードインテリジェンスフォーマット
2866
- **高度な検索**:最適なツール(ugrep、ripgrep、ag、grep)を自動検出・使用
29-
- **正規表現サポート**:ReDoS攻撃防御付きの完全な正規表現パターンマッチング
30-
- **ファジー検索**:真の編集距離ファジーマッチング(ugrep)または単語境界パターンマッチング
67+
- **汎用理解**:単一システムですべてのプログラミング言語を理解
3168
- **ファイル解析**:構造、インポート、クラス、メソッド、複雑度メトリクスへの深い洞察
3269

3370
### 🗂️ **多言語サポート**
34-
- **主流言語**:Java、Python、JavaScript/TypeScript、C/C++、Go、Rust、C#
35-
- **モバイル開発**:Swift、Kotlin、Objective-C/C++、React Native
36-
- **Webフロントエンド**:Vue、React、Svelte、Astro、HTML、CSS、SCSS
37-
- **データベース**:SQL (MySQL、PostgreSQL、SQLite)、NoSQL、ストアドプロシージャ、マイグレーション
38-
- **スクリプト言語**:Ruby、PHP、Shell、PowerShell、Bash
39-
- **システム言語**:C/C++、Rust、Go、Zig
40-
- **JVMエコシステム**:Java、Kotlin、Scala、Groovy
41-
- **その他の言語**:Lua、Perl、R、MATLAB、設定ファイル
42-
- **合計50+ファイルタイプ** - [完全なリストを表示](#サポートされているファイルタイプ)
71+
- **50+ファイルタイプ**:Java、Python、JavaScript/TypeScript、C/C++、Go、Rust、C#、Swift、Kotlin、Ruby、PHPなど
72+
- **Webフロントエンド**:Vue、React、Svelte、HTML、CSS、SCSS
73+
- **データベース**:SQLバリアント、NoSQL、ストアドプロシージャ、マイグレーション
74+
- **設定ファイル**:JSON、YAML、XML、Markdown
75+
- **[完全なリストを表示](#サポートされているファイルタイプ)**
4376

4477
### **リアルタイム監視・自動更新**
4578
- **ファイルウォッチャー**:ファイル変更時の自動インデックス更新
46-
- **クロスプラットフォーム**ネイティブOS ファイルシステム監視 (inotify、FSEvents、ReadDirectoryChangesW)
47-
- **スマートデバウンス**:急速な変更をバッチ処理して過度な再構築を防止(デフォルト:6秒)
48-
- **スレッドセーフ**ThreadPoolExecutor による非ブロッキングバックグラウンド操作
79+
- **クロスプラットフォーム**ネイティブOSファイルシステム監視
80+
- **スマート処理**:急速な変更をバッチ処理して過度な再構築を防止
81+
- **豊富なメタデータ**シンボル、参照、定義、関連性をキャプチャ
4982

5083
### **パフォーマンス・効率性**
5184
- **スマートインデックス作成**:ビルドディレクトリをインテリジェントにフィルタリングしながら再帰的スキャン

README_zh.md

Lines changed: 47 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,30 +22,63 @@
2222

2323
**適用於:**程式碼審查、重構、文件生成、除錯協助和架構分析。
2424

25+
## 快速開始
26+
27+
### 🚀 **推薦設定(大多數使用者)**
28+
29+
與任何 MCP 相容應用程式開始的最簡單方式:
30+
31+
**前置需求:** Python 3.10+ 和 [uv](https://github.com/astral-sh/uv)
32+
33+
1. **新增到您的 MCP 設定** (例如 `claude_desktop_config.json``~/.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. **重新啟動應用程式**`uvx` 會自動處理安裝和執行
46+
47+
3. **開始使用**
48+
```
49+
設定專案路徑為 /Users/dev/my-react-app
50+
在這個專案中找到所有 TypeScript 檔案
51+
搜尋「authentication」相關函數
52+
分析主要的 App.tsx 檔案
53+
```
54+
55+
## 典型使用場景
56+
57+
**程式碼審查**:「找出所有使用舊 API 的地方」
58+
**重構協助**:「這個函數在哪裡被呼叫?」
59+
**學習專案**:「顯示這個 React 專案的主要元件」
60+
**除錯協助**:「搜尋所有錯誤處理相關的程式碼」
61+
2562
## 主要特性
2663

2764
### 🔍 **智慧搜尋與分析**
65+
- **SCIP 驅動**:業界標準程式碼智能格式,被主流 IDE 採用
2866
- **進階搜尋**:自動偵測並使用最佳工具(ugrep、ripgrep、ag 或 grep)
29-
- **正規表達式支援**:完整的正規表達式模式匹配,具備 ReDoS 攻擊防護
30-
- **模糊搜尋**:真正的編輯距離模糊匹配(ugrep)或詞邊界模式匹配
67+
- **通用理解**:單一系統理解所有程式語言
3168
- **檔案分析**:深入了解結構、匯入、類別、方法和複雜度指標
3269

3370
### 🗂️ **多語言支援**
34-
- **主流語言**:Java、Python、JavaScript/TypeScript、C/C++、Go、Rust、C#
35-
- **行動開發**:Swift、Kotlin、Objective-C/C++、React Native
36-
- **網頁前端**:Vue、React、Svelte、Astro、HTML、CSS、SCSS
37-
- **資料庫**:SQL (MySQL、PostgreSQL、SQLite)、NoSQL、存儲過程、遷移腳本
38-
- **腳本語言**:Ruby、PHP、Shell、PowerShell、Bash
39-
- **系統語言**:C/C++、Rust、Go、Zig
40-
- **JVM 生態系**:Java、Kotlin、Scala、Groovy
41-
- **其他語言**:Lua、Perl、R、MATLAB、配置檔案
42-
- **共 50+ 種檔案類型** - [查看完整列表](#支援的檔案類型)
71+
- **50+ 種檔案類型**:Java、Python、JavaScript/TypeScript、C/C++、Go、Rust、C#、Swift、Kotlin、Ruby、PHP 等
72+
- **網頁前端**:Vue、React、Svelte、HTML、CSS、SCSS
73+
- **資料庫**:SQL 變體、NoSQL、存儲過程、遷移腳本
74+
- **配置檔案**:JSON、YAML、XML、Markdown
75+
- **[查看完整列表](#支援的檔案類型)**
4376

4477
### **即時監控與自動刷新**
4578
- **檔案監控器**:檔案變更時自動更新索引
46-
- **跨平台**:原生作業系統檔案系統監控 (inotify、FSEvents、ReadDirectoryChangesW)
47-
- **智慧防抖**:批次處理快速變更以防止過度重建(預設:6 秒)
48-
- **執行緒安全**使用 ThreadPoolExecutor 進行非阻塞背景操作
79+
- **跨平台**:原生作業系統檔案系統監控
80+
- **智慧處理**:批次處理快速變更以防止過度重建
81+
- **豐富元資料**捕獲符號、引用、定義和關聯性
4982

5083
### **效能與效率**
5184
- **智慧索引**:遞迴掃描並智慧篩選建構目錄

0 commit comments

Comments
 (0)