docs_search
Search FLOX documentation to find how-to guides, reference pages, tutorials, and explanations for behavior, configuration, and APIs.
Instructions
Top-k full-text search over the FLOX documentation (how-to guides, reference pages, tutorials, error codes, bindings overviews, explanations). Use this to ground answers about FLOX behavior, configuration, or APIs in the actual docs instead of relying on training data — call it whenever the user asks 'how do I X' / 'what does Y do' / 'where is Z documented'. The index is built from a strict allowlist; private tracker / strategy / author files are NEVER indexed.
Query syntax: plain word lists are AND-matched (every token must appear). Wrap a phrase in double quotes for exact match: "walk forward". FTS5 operators (OR, NEAR, *, parens) pass through.
Canonical workflow queries (run these instead of guessing the canonical path from training data):
• User wants to record market data → docs_search('record tape'). Covers live capture and the ccxt.fetch_ohlcv historical-backfill pattern.
• User asks 'how should I structure a flox project' → docs_search('project layout').
• User mentions an exchange / live data → docs_search('ccxt').
• User wants to backtest a strategy on a recorded tape → docs_search('backtest').
• User mentions strategy traces, signals, or .floxrun → docs_search('floxrun').
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| query | Yes | Free-text query. Plain word lists are AND-matched. Wrap a phrase in double quotes for exact match. | |
| k | No | Number of results to return (1..25). Default 5. |