Skip to main content
Glama

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

NameRequiredDescriptionDefault
rawNoRaw javadoc text instead of the rendered form.
queryYesThe symbol reference, type, pattern or glob the command asks about. Quote refs containing # or (). Empty only where the command allows it (ls, tree).
maxLinesNoCap the doc text (default 200).
inheritedNoAllow the supertype fallback (the default; accepted for explicitness).
workspaceNoNamed workspace to answer from (default: the workspace the server was started with). Stored workspaces only.
no-inheritedNoOnly docs written on this exact symbol (mutually exclusive with inherited).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.7.0

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations supplied, the description carries the full burden, and it does disclose one real behavioral trait: fallback to the nearest documenting supertype. It says nothing about permissions, cost, output shape, or whether the fallback is silent, so meaningful gaps remain.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with zero filler; the core purpose and the fallback behavior both land immediately. It is arguably terse for a tool with six parameters and no annotations, but nothing is wasted.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For six parameters with no annotations and no output schema, the description covers purpose and inheritance fallback but omits how workspace selection, maxLines, or raw-vs-rendered output behave in practice. The rich schema compensates for much of this, leaving the definition adequate rather than complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the parameters are already well documented and the baseline applies. The description only indirectly illuminates the inherited/no-inherited pair through its fallback sentence and adds no syntax or format detail beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource – retrieve documentation for a type or member – and the IntelliJ quick-doc analogy pins down the expected shape of the result. It is clearly distinct from siblings like jdx_body or jdx_source, though it never names them.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied: reach for this when you want documentation rather than source or signatures. There is no explicit when-to-use/when-not statement and no named alternative (e.g. jdx_body for source text), so the routing decision is left partly to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.