Search the documentation
search_docsSearches for a term in the indexed documentation of a version. Applies stemming and domain synonyms, so morphological variants and synonyms also match. Pass exactly one of 'query' and 'queries' — the latter runs several searches in one call, each under 'searches'. When 'truncated' is true, 'next_page' is the value of 'page' for the next results. A match under a heading names it in 'heading', and its 'url' ends in that section's #anchor: get_doc_page on that URL reads just the section. May also return a livekit block: pointers to LiveKit's SDK documentation, which is NOT OpenVidu documentation and carries its own version caveat — read that block's own guidance before using it. The response includes 'version_used': always tell the user which documentation version what you're telling them corresponds to. If it also carries 'version_warning', or 'version_sensitive': true on a result or in a page's 'version_note', the page changes between versions: say so explicitly and explain how to specify a different one. The index has no notion of edition or product, so if the answer depends on either, say which one you assumed.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "search_docs"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Which page of results, from 1. | |
| query | No | Term or phrase to search for (case-insensitive). | |
| queries | No | Several queries instead of 'query', up to 5: different phrasings of the same question, or related ones. | |
| version | No | Version of the OpenVidu SERVER the project's deployment runs, as the deployment reports it ('3.9.0', '3.9.1'): documentation is published per minor release, so it resolves to '3.9'. DO NOT INFER it from the project's dependencies (livekit-client, livekit-server-sdk, web components): their versions do NOT correspond to the server's, and passing one here returns documentation for the wrong version. To find out for real, call 'resolve_openvidu_version_edition_product' with no arguments: it returns the procedure to obtain the version, the edition (ce/pro) and the product (Platform/Meet) from the deployment itself. Cheaper first check: the project's AGENTS.md/CLAUDE.md, where it may already be pinned. If you have none of these, OMIT the parameter: the default version is used and the response tells you whether that matters for the page being queried. Don't guess. | |
| max_results | No | Results per page. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| query | No | ||
| livekit | No | Pointers to LiveKit's own documentation. NOT OpenVidu results. | |
| results | No | ||
| searches | No | ||
| next_page | No | ||
| truncated | No | More results exist beyond this page. | |
| version_used | Yes | Documentation version that answered. | |
| resolved_from | Yes | How it was chosen: default, explicit, normalized, alias_latest, or url (the release a get_doc_page URL names). | |
| total_matches | No | ||
| default_version | Yes | ||
| available_versions | Yes |