jdx_doc
Retrieve quick documentation for a JVM type or member, falling back to the nearest documenting supertype when the exact symbol lacks docs.
Instructions
Quick documentation for a type or member, falling back to the nearest documenting supertype like IntelliJ quick-doc.
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": "jdx_doc"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| raw | No | Raw javadoc text instead of the rendered form. | |
| query | Yes | The symbol reference, type, pattern or glob the command asks about. Quote refs containing # or (). Empty only where the command allows it (ls, tree). | |
| maxLines | No | Cap the doc text (default 200). | |
| inherited | No | Allow the supertype fallback (the default; accepted for explicitness). | |
| workspace | No | Named workspace to answer from (default: the workspace the server was started with). Stored workspaces only. | |
| no-inherited | No | Only docs written on this exact symbol (mutually exclusive with inherited). |