vault_search
Read-onlyIdempotent
Search a knowledge vault using full-text queries, ranked relevance, or recent changes. Apply filters by type, status, tag, project, or scope.
Instructions
Search the vault: full-text, ranked, or recent changes.
Default mode: flat full-text search across all vault files. Ranked mode (ranked=True): results scored by relevance. Recent mode (since_days>0): files changed in the last N days. rank_by mode (rank_by != 'bm25'): lessons-only, ranked by usage.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | No | Text to search for (case-insensitive). | |
| max_lines | No | Maximum output lines. Default 500. | |
| type_filter | No | Only files whose frontmatter type matches. | |
| status_filter | No | Only files whose frontmatter status matches. | |
| tag_filter | No | Only files that have this frontmatter tag. | |
| use_regex | No | Treat query as regex. Default False. (Use `use_regex`, not `regex` — `regex` is accepted as an alias.) | |
| ranked | No | Score results by relevance. Default False. | |
| max_results | No | Max result files. Default 10. Caps the file count in all modes (flat, ranked, recent); in flat/recent the cap is by path order (alphabetical) — use ranked=True for relevance order. | |
| since_days | No | Show recent changes (0 = disabled). Default 0. | |
| project | No | Filter to this project (recent mode only). | |
| scope | No | Restrict search to a scope (e.g. 'work', 'projects'). Empty = all. | |
| rank_by | No | Lesson ranking ('bm25' default keeps current behaviour; 'reinforcements', 'confidence', 'hybrid' filter to 90-lessons.md only and rank by usage signal). | bm25 |
| regex | No | Alias of `use_regex` (#151). Prefer `use_regex`. To narrow by location use `scope` / `project`, not `path_filter` / `path_prefix`. | |
| limit | No | Alias of `max_results` (#202). Prefer `max_results`. When both are given the tighter (smaller) cap wins; 0 = unset. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |