vyos_docs_search
Search VyOS documentation by topic to find pages with matching path and body content, ranked by relevance.
Instructions
Search VyOS documentation by topic (path and page content).
Ranks matching doc pages by how many query terms appear in the path
and body. Each result is a dict with 'path', 'title', and 'snippet'
(a context excerpt when the query matches the page body, else None).
Use vyos_docs_read to fetch the full content of a result.
Args:
query: Search terms, e.g. "firewall group" or "nat hairpin"
max_results: Maximum number of results to return (default 10).
Capped internally at ~30 (only fetched pages can rank).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | ||
| max_results | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |