Skip to content

Commit 81bcad4

Browse files
committed
docs: document search pagination defaults
1 parent 8ad1461 commit 81bcad4

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ Then configure:
262262
### 🔍 **Search & Discovery**
263263
| Tool | Description |
264264
|------|-------------|
265-
| **`search_code_advanced`** | Smart search with regex, fuzzy matching, and file filtering |
265+
| **`search_code_advanced`** | Smart search with regex, fuzzy matching, file filtering, and paginated results (10 per page by default) |
266266
| **`find_files`** | Locate files using glob patterns (e.g., `**/*.py`) |
267267
| **`get_file_summary`** | Analyze file structure, functions, imports, and complexity (requires deep index) |
268268

@@ -331,7 +331,7 @@ Find authentication-related functions with fuzzy search for 'authUser'
331331
```
332332
Search for "API_ENDPOINT" only in Python files
333333
```
334-
*Uses: `search_code_advanced` with `file_pattern: "*.py"`*
334+
*Uses: `search_code_advanced` with `file_pattern: "*.py"` (defaults to 10 matches; use `max_results` to expand or `start_index` to page)*
335335

336336
</details>
337337

README_ja.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ pip install code-index-mcp
284284
### 🔍 **検索・発見**
285285
| ツール | 説明 |
286286
|--------|------|
287-
| **`search_code_advanced`** | 正規表現、ファジーマッチング、ファイルフィルタリング対応のスマート検索 |
287+
| **`search_code_advanced`** | 正規表現、ファジーマッチング、ファイルフィルタリング対応のスマート検索。デフォルトで 1 ページあたり 10 件を返し、`max_results``start_index` で調整可能 |
288288
| **`find_files`** | globパターンを使用したファイル検索(例:`**/*.py`|
289289
| **`get_file_summary`** | ファイル構造、関数、インポート、複雑度の解析(深いインデックスが必要) |
290290

@@ -353,7 +353,7 @@ src/api/userService.ts の要約を教えてください
353353
```
354354
Pythonファイルのみで "API_ENDPOINT" を検索してください
355355
```
356-
*使用ツール:`search_code_advanced``file_pattern: "*.py"`*
356+
*使用ツール:`search_code_advanced``file_pattern: "*.py"`(デフォルトは 10 件。`max_results` で件数を増やし、`start_index` でページ送り)*
357357

358358
</details>
359359

README_ko.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Linux와 macOS는 운영체제가 `HOME`과 XDG 경로를 기본으로 제공하
189189
### 🔍 **검색 & 탐색**
190190
| 도구 | 설명 |
191191
|------|------|
192-
| **`search_code_advanced`** | 정규식, 퍼지 매칭, 파일 필터링을 지원하는 스마트 검색 |
192+
| **`search_code_advanced`** | 정규식, 퍼지 매칭, 파일 필터링을 지원하는 스마트 검색 (기본적으로 페이지당 10개 결과 반환, `max_results`·`start_index`로 조정 가능) |
193193
| **`find_files`** | 글롭 패턴으로 파일 찾기 (예: `**/*.py`) |
194194
| **`get_file_summary`** | 파일 구조, 함수, 임포트, 복잡도를 분석 (심층 인덱스 필요) |
195195

@@ -258,7 +258,7 @@ src/api/userService.ts 요약을 알려줘
258258
```
259259
Python 파일에서만 "API_ENDPOINT" 를 찾아줘
260260
```
261-
*`search_code_advanced` + `file_pattern="*.py"`*
261+
*`search_code_advanced` + `file_pattern="*.py"` (기본 10개 결과, `max_results`로 확장하고 `start_index`로 페이지 이동)*
262262

263263
</details>
264264

README_zh.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ pip install code-index-mcp
281281
### 🔍 **搜尋與探索**
282282
| 工具 | 描述 |
283283
|------|------|
284-
| **`search_code_advanced`** | 智慧搜尋,支援正規表達式、模糊匹配和檔案篩選 |
284+
| **`search_code_advanced`** | 智慧搜尋,支援正規表達式、模糊匹配和檔案篩選,預設每頁回傳 10 筆結果,可透過 `max_results``start_index` 調整 |
285285
| **`find_files`** | 使用萬用字元模式尋找檔案(例如 `**/*.py`|
286286
| **`get_file_summary`** | 分析檔案結構、函式、匯入和複雜度(需要深度索引) |
287287

@@ -350,7 +350,7 @@ pip install code-index-mcp
350350
```
351351
只在 Python 檔案中搜尋 "API_ENDPOINT"
352352
```
353-
*使用:`search_code_advanced``file_pattern: "*.py"`*
353+
*使用:`search_code_advanced``file_pattern: "*.py"`(預設回傳 10 筆;使用 `max_results` 擴充或 `start_index` 換頁)*
354354

355355
</details>
356356

0 commit comments

Comments
 (0)