atlas_index
Index or re-index source code and documents into a local search index, supporting incremental updates and full rebuilds to keep the codebase searchable.
Instructions
Index (or re-index) source code and documents into the local search index.
Use to build the index the first time, or to refresh it after atlas_status
reports is_stale: true or large changes.
IMPORTANT: unless the user already said what to index, call with dry_run=true first, show the candidate folders, and ASK whether to index everything or specific folders. Then call again with the chosen 'paths' (or none for the whole workspace).
Incremental by default: unchanged files (by content hash) are skipped, so re-runs are fast. full=true forces a complete rebuild.
full=true or empty/omitted 'paths' (whole-workspace) run asynchronously in a
background subprocess and return immediately — poll atlas_status
(reindexing: true while running). A non-empty 'paths' with full=false runs
synchronously and returns stats directly.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| full | No | Force full re-index ignoring cached hashes. Defaults to false. | |
| paths | No | Optional subfolders (relative to 'workspace') to index, e.g. ["src", "docs"]. Omitted = whole workspace. No path traversal outside it. | |
| dry_run | No | When true, indexes nothing; returns top-level candidate folders with eligible-file counts so you can present them before deciding. Defaults to false. | |
| workspace | No | Absolute path to index. Defaults to the parent of the resolved index, else the current directory. Must exist and be a directory. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |