Browse the docs

search_docs

Searches the docs bundled in the installed Switchboard, so an agent reads what this version does before it writes a macro.

Details #

search_docs searches the same docs the Help window shows: the guides, a page for every step, trigger, condition, token and function, the command line, the local API, these tools, and the macro file format (format/macro-file, made from the schema). They come from the installed app, so an agent never reads about a step this version doesn't have.

Each hit has an id for read_doc, its title, its kind, a one-line summary and a snippet of where the words matched. Hits are ranked the way the Help window ranks them: the title first, then keywords, the summary, headings and the text.

{ "jsonrpc": "2.0", "id": 5, "method": "tools/call",
  "params": { "name": "search_docs", "arguments": { "query": "wait for a window", "kind": "step" } } }

The answer is {query, total, offset, results, nextOffset?}. Ten hits come back unless you ask for more (25 at most); pass nextOffset back as offset for the next ten.

See also #