search
Search notes by query. Returns snippets with a heading breadcrumb (title > section > subsection) that locates the approximate section, plus a precise toc_path per match. Each result carries note_path (string) and note_id (integer); each match carries match_id (string, form "p:c"). Drill-down workflow: 1) search to find the approximate section via the breadcrumb; 2) call note_html(path=<result.note_path>, toc_path=[...]) to read the matched section, or expand(path=<result.note_path>, toc_path=[...]) to navigate the note's structure level by level; 3) note_html(path=<result.note_path>, match_id=<match.match_id>) for a focused chunk window. Each match also carries section_url — a link straight to that heading, for citing the section rather than the whole note. The optional fields each run an extra search whose results are merged with the main one; fill them to find more.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max number of results to return (default 6) | |
| query | Yes | The user's question exactly as they asked it. Do not rewrite it. | |
| short_query | No | Optional. 2-3 words in English that the answering note is sure to contain: the main term and one qualifier, in dictionary form (nominative singular, infinitive). A short phrase, not a list; no punctuation. Keyword search needs every word to match, so fewer precise words beat many. | |
| detail_limit | No | How many results include full snippet matches; results beyond this are returned as lightweight previews (title, path, score) to save context (default 3) | |
| expected_answer | No | Optional. One or two sentences in English that the answering note itself could contain, written the way the notes state facts (e.g. 'To reset a password, open Settings and select Security.'). Not a description of what the note covers, not a question. If unsure of details, stay general but keep it a statement of fact. | |
| rephrased_query | No | Optional. The question asked another way in English: different words, and the canonical name of what it asks about if you know it. One sentence. |