atlas_search
Read-onlyIdempotent
Search indexed documentation sections with BM25 full-text ranking to locate broad or multi-section topics, returning ranked anchor-linked snippets for follow-up reads.
Instructions
Run a BM25 full-text search across documentation sections and return ranked snippets with anchors.
Use this tool for broad or multi-section topics ('where all is armor mentioned?') or when
`atlas_where` returns no single match. Pass a returned `anchor` to `atlas_read` to inspect the full section.
Behavior & Output:
- Read-only lexical search via SQLite FTS5 (no embeddings; project synonyms come from `.atlas/aliases.yml`).
- Returns a JSON string `{query, count, hits: [{anchor, title, path, line, snippet, score}]}`.
Returns `count: 0` and an empty `hits` list if nothing matches.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| k | No | Maximum number of ranked section hits to return (1-50, default 5). | |
| doc | No | Optional document ID (e.g. 'combat' or '02-combat') to restrict the search to a single document. Omit or pass null to search all documents. | |
| query | Yes | Keywords or phrase to search across all indexed documentation sections (e.g. 'cover reduction', 'turn order'). Uses lexical FTS5 matching with umlaut folding ('Hoehe' matches 'Höhe') and German compound splitting. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |