search_documentation
Find documentation matches by searching the bundled skill tree and any local Synthesizer checkout. Returns hits with file paths, line numbers, and snippets.
Instructions
Search the bundled skill tree and any Synthesizer checkout docs.
Args: query: Words to look for. Matching is plain substring and token matching, not a query language.
Returns:
A mapping with query, corpora_searched (a list of
{corpus, root} recording what was actually covered),
corpora_unavailable explaining, in a sentence each, any
corpus that was not,
files_scanned, hit_count, and hits. Each hit is
{corpus, path, line, score, snippet} where snippet is an
untrusted-content envelope. truncated records whether a cap
bit, notes explains an unsearchable query, and error is
present only when the search itself failed.
The bundled skill tree is always searched; a Synthesizer source
checkout is searched in addition to it when one is found, never
instead of it. Synthesizer's own documentation is not installed
by pip, so it is unavailable unless such a checkout exists.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||