Warm
warmIndex files into the cache to make them searchable, returning counts of indexed, current, and skipped files. Use before searching to ensure up-to-date results.
Instructions
Index files into the cache so grep and search can see them, returning counts only.
Costs a few dozen tokens however many files it indexes: no content, no previews, no paths for the files that succeeded — just how many were indexed, how many were already current, and how many were not.
Anything not indexed is counted in skipped, and the first few come back
under failures with a reason (not_found, not_a_file, binary,
too_large, unreadable, timeout). If a cap stopped the walk early you
get truncated or incomplete rather than a short count that looks
complete.
Use it before searching an unfamiliar tree, then grep for the exact
string or search for the concept, and read only what those name.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| paths | Yes | Files to index — a comma-separated list, a JSON array, or glob patterns (expanded for you, e.g. `src/**/*.py`). | |
| max_files | No | Cap on files indexed in this call. Matches beyond it are left out and flagged with `truncated`. |