search_query
Search an index. The default hybrid ranking fuses exact-keyword matching (typo-tolerant, great for SKUs, usernames, IDs, and any literal term) with meaning-based matching — so a document containing the query words ranks first, AND conceptually related documents are still found. Each result has its original content and metadata, a relevance score, a snippet that highlights the match (wrapped in …), and a signals breakdown of which signal(s) matched. offset pages through results — the response carries a page object with total and has_more.
Example:
{
"project_id": "my-saas",
"index": "help-articles",
"query": "reset password",
"limit": 5
}
// Returns: {
// "results": [{ "id": "art-1", "content": "How to reset your password...", "metadata": { "category": "account" }, "score": 0.031, "snippet": "How to <mark>reset</mark> your <mark>password</mark>...", "signals": { "lexical": -3.1, "semantic": 0.92 } }, ...],
// "page": { "offset": 0, "limit": 5, "total": 12, "has_more": true },
// "mode": "hybrid"
// }Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"project_id": "<project_id>",
"index": "<index>",
"query": "<query>"
},
"name": "search_query"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Ranking mode: 'hybrid' (default — keyword + meaning, fused), 'semantic' (meaning only), or 'lexical' (keyword only, with typo-tolerant prefix matching). | |
| index | Yes | Index name to search. | |
| limit | No | Max results per page (default 10, max 100). | |
| query | Yes | Query text — keywords and/or natural language. | |
| offset | No | Skip this many results for pagination (default 0). Pages together with limit; the response includes page.total and page.has_more. Applies to hybrid and lexical modes. | |
| project_id | Yes | Project ID (UUID), subdomain, or slug — resolved server-side, no UUID lookup needed. 'default' also works when the account has exactly one project; multi-project accounts must name one (the error lists them). |