Search AdonisJS docs
search_docsSearch AdonisJS documentation by keyword to get ranked doc IDs. Supports core framework, Lucid ORM, Edge, Vine, and Japa, with version detection.
Instructions
Keyword search over AdonisJS documentation (core v4–v7, Lucid ORM, or Edge templates). Returns a compact ranked list of doc ids — pass an id to get_doc to read the page.
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": {
"query": "<query>"
},
"name": "search_docs"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Max results (default 8). | |
| query | Yes | Keywords to search for, e.g. 'lucid relationships' or 'auth middleware'. | |
| library | No | Docs to search: 'core' framework docs (default, version-aware), 'lucid' ORM, 'edge' templates, 'vine' validation, or 'japa' testing. | |
| version | No | AdonisJS version. Omit to auto-detect from projectPath (defaults to v7 when neither is given). | |
| projectPath | No | Path to an AdonisJS project root (or its package.json) used to auto-detect the version. |