Skip to content

Commit 3fc0d2e

Browse files
committed
docs: update README files to clarify indexing commands and their usage
1 parent 5da5c4e commit 3fc0d2e

File tree

3 files changed

+24
-12
lines changed

3 files changed

+24
-12
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ The easiest way to get started with any MCP-compatible application:
6666
- **Direct Tree-sitter Integration**: No regex fallbacks for specialized languages - fail fast with clear errors
6767
- **Advanced Search**: Auto-detects and uses the best available tool (ugrep, ripgrep, ag, or grep)
6868
- **Universal File Support**: Comprehensive coverage from advanced AST parsing to basic file indexing
69-
- **File Analysis**: Deep insights into structure, imports, classes, methods, and complexity metrics
69+
- **File Analysis**: Deep insights into structure, imports, classes, methods, and complexity metrics after running `build_deep_index`
7070

7171
### 🗂️ **Multi-Language Support**
7272
- **7 Languages with Tree-sitter AST Parsing**: Python, JavaScript, TypeScript, Java, Go, Objective-C, Zig
@@ -81,7 +81,7 @@ The easiest way to get started with any MCP-compatible application:
8181
- **File Watcher**: Automatic index updates when files change
8282
- **Cross-platform**: Native OS file system monitoring
8383
- **Smart Processing**: Batches rapid changes to prevent excessive rebuilds
84-
- **Rich Metadata**: Captures symbols, references, definitions, and relationships
84+
- **Shallow Index Refresh**: Watches file changes and keeps the file list current; run a deep rebuild when you need symbol metadata
8585

8686
### **Performance & Efficiency**
8787
- **Tree-sitter AST Parsing**: Native syntax parsing for accurate symbol extraction
@@ -218,15 +218,18 @@ Then configure:
218218
| Tool | Description |
219219
|------|-------------|
220220
| **`set_project_path`** | Initialize indexing for a project directory |
221-
| **`refresh_index`** | Rebuild the project index after file changes |
221+
| **`refresh_index`** | Rebuild the shallow file index after file changes |
222+
| **`build_deep_index`** | Generate the full symbol index used by deep analysis |
222223
| **`get_settings_info`** | View current project configuration and status |
223224

225+
*Run `build_deep_index` when you need symbol-level data; the default shallow index powers quick file discovery.*
226+
224227
### 🔍 **Search & Discovery**
225228
| Tool | Description |
226229
|------|-------------|
227230
| **`search_code_advanced`** | Smart search with regex, fuzzy matching, and file filtering |
228231
| **`find_files`** | Locate files using glob patterns (e.g., `**/*.py`) |
229-
| **`get_file_summary`** | Analyze file structure, functions, imports, and complexity |
232+
| **`get_file_summary`** | Analyze file structure, functions, imports, and complexity (requires deep index) |
230233

231234
### 🔄 **Monitoring & Auto-refresh**
232235
| Tool | Description |
@@ -263,6 +266,7 @@ Find all TypeScript component files in src/components
263266
Give me a summary of src/api/userService.ts
264267
```
265268
*Uses: `get_file_summary` to show functions, imports, and complexity*
269+
*Tip: run `build_deep_index` first if you get a `needs_deep_index` response.*
266270

267271
### 🔍 **Advanced Search Examples**
268272

README_ja.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Code Index MCPは、AIモデルと複雑なコードベースの橋渡しをす
6666
- **直接Tree-sitter統合**:特化言語で正規表現フォールバックなし - 明確なエラーメッセージで高速フェイル
6767
- **高度な検索**:最適なツール(ugrep、ripgrep、ag、grep)を自動検出・使用
6868
- **汎用ファイルサポート**:高度なAST解析から基本ファイルインデックスまでの包括的カバレッジ
69-
- **ファイル解析**構造、インポート、クラス、メソッド、複雑度メトリクスへの深い洞察
69+
- **ファイル解析**`build_deep_index` 実行後に構造、インポート、クラス、メソッド、複雑度メトリクスを深く把握
7070

7171
### 🗂️ **多言語サポート**
7272
- **7言語でTree-sitter AST解析**:Python、JavaScript、TypeScript、Java、Go、Objective-C、Zig
@@ -81,7 +81,7 @@ Code Index MCPは、AIモデルと複雑なコードベースの橋渡しをす
8181
- **ファイルウォッチャー**:ファイル変更時の自動インデックス更新
8282
- **クロスプラットフォーム**:ネイティブOSファイルシステム監視
8383
- **スマート処理**:急速な変更をバッチ処理して過度な再構築を防止
84-
- **豊富なメタデータ**シンボル、参照、定義、関連性をキャプチャ
84+
- **浅いインデックス更新**ファイル変更を監視して最新のファイル一覧を維持し、シンボルが必要な場合は `build_deep_index` を実行
8585

8686
### **パフォーマンス・効率性**
8787
- **Tree-sitter AST解析**:正確なシンボル抽出のためのネイティブ構文解析
@@ -240,15 +240,18 @@ pip install code-index-mcp
240240
| ツール | 説明 |
241241
|--------|------|
242242
| **`set_project_path`** | プロジェクトディレクトリのインデックス作成を初期化 |
243-
| **`refresh_index`** | ファイル変更後にプロジェクトインデックスを再構築 |
243+
| **`refresh_index`** | ファイル変更後に浅いファイルインデックスを再構築 |
244+
| **`build_deep_index`** | 深い解析で使う完全なシンボルインデックスを生成 |
244245
| **`get_settings_info`** | 現在のプロジェクト設定と状態を表示 |
245246

247+
*シンボルレベルのデータが必要な場合は `build_deep_index` を実行してください。デフォルトの浅いインデックスは高速なファイル探索を担います。*
248+
246249
### 🔍 **検索・発見**
247250
| ツール | 説明 |
248251
|--------|------|
249252
| **`search_code_advanced`** | 正規表現、ファジーマッチング、ファイルフィルタリング対応のスマート検索 |
250253
| **`find_files`** | globパターンを使用したファイル検索(例:`**/*.py`|
251-
| **`get_file_summary`** | ファイル構造、関数、インポート、複雑度の解析 |
254+
| **`get_file_summary`** | ファイル構造、関数、インポート、複雑度の解析(深いインデックスが必要) |
252255

253256
### 🔄 **監視・自動更新**
254257
| ツール | 説明 |
@@ -285,6 +288,7 @@ src/components で全てのTypeScriptコンポーネントファイルを見つ
285288
src/api/userService.ts の要約を教えてください
286289
```
287290
*使用ツール:`get_file_summary` で関数、インポート、複雑度を表示*
291+
*ヒント:`needs_deep_index` が返った場合は `build_deep_index` を先に実行してください。*
288292

289293
### 🔍 **高度な検索例**
290294

README_zh.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@
6666
- **直接 Tree-sitter 整合**:專業化語言無正則表達式備用 - 快速失敗並提供清晰錯誤訊息
6767
- **進階搜尋**:自動偵測並使用最佳工具(ugrep、ripgrep、ag 或 grep)
6868
- **通用檔案支援**:從進階 AST 解析到基本檔案索引的全面覆蓋
69-
- **檔案分析**深入了解結構、匯入、類別、方法和複雜度指標
69+
- **檔案分析**執行 `build_deep_index` 後深入了解結構、匯入、類別、方法和複雜度指標
7070

7171
### 🗂️ **多語言支援**
7272
- **7 種語言使用 Tree-sitter AST 解析**:Python、JavaScript、TypeScript、Java、Go、Objective-C、Zig
@@ -81,7 +81,7 @@
8181
- **檔案監控器**:檔案變更時自動更新索引
8282
- **跨平台**:原生作業系統檔案系統監控
8383
- **智慧處理**:批次處理快速變更以防止過度重建
84-
- **豐富元資料**捕獲符號、引用、定義和關聯性
84+
- **淺層索引更新**監控檔案變更並維持檔案清單最新;需要符號資料時請執行 `build_deep_index`
8585

8686
### **效能與效率**
8787
- **Tree-sitter AST 解析**:原生語法解析以實現準確的符號提取
@@ -240,15 +240,18 @@ pip install code-index-mcp
240240
| 工具 | 描述 |
241241
|------|------|
242242
| **`set_project_path`** | 為專案目錄初始化索引 |
243-
| **`refresh_index`** | 在檔案變更後重建專案索引 |
243+
| **`refresh_index`** | 在檔案變更後重建淺層檔案索引 |
244+
| **`build_deep_index`** | 產生供深度分析使用的完整符號索引 |
244245
| **`get_settings_info`** | 檢視目前專案配置和狀態 |
245246

247+
*需要符號層級資料時,請執行 `build_deep_index`;預設的淺層索引提供快速檔案探索。*
248+
246249
### 🔍 **搜尋與探索**
247250
| 工具 | 描述 |
248251
|------|------|
249252
| **`search_code_advanced`** | 智慧搜尋,支援正規表達式、模糊匹配和檔案篩選 |
250253
| **`find_files`** | 使用萬用字元模式尋找檔案(例如 `**/*.py`|
251-
| **`get_file_summary`** | 分析檔案結構、函式、匯入和複雜度 |
254+
| **`get_file_summary`** | 分析檔案結構、函式、匯入和複雜度(需要深度索引) |
252255

253256
### 🔄 **監控與自動刷新**
254257
| 工具 | 描述 |
@@ -285,6 +288,7 @@ pip install code-index-mcp
285288
給我 src/api/userService.ts 的摘要
286289
```
287290
*使用:`get_file_summary` 顯示函式、匯入和複雜度*
291+
*提示:若收到 `needs_deep_index` 回應,請先執行 `build_deep_index`*
288292

289293
### 🔍 **進階搜尋範例**
290294

0 commit comments

Comments
 (0)