Open Kioku Explain Symbol

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false. Description adds context that it 'reads from the local index', which provides additional clarity about the data source, though much of the behavioral profile is already covered by annotations.

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

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

Description is two sentences, front-loaded with purpose and return fields. There is minor redundancy between the first sentence and the start of the second, but overall it is efficient and well-structured.

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

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

For a tool with one parameter and an output schema present, the description covers purpose, input semantics, return content, behavioral constraints, and usage boundaries. No gaps remain for the agent to make an informed invocation.

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

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

Input schema covers 100% of the single parameter 'query'. Description adds meaning by specifying that it matches 'exact or partial name' and against 'indexed symbol names and qualified names', which goes beyond the schema's basic description.

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

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

Description clearly states it retrieves a concise explanation of one indexed symbol, listing specific return fields (definition range, qualified name, kind, direct structural relationships). It distinguishes from sibling tools like get_symbol_context and search_symbols by specifying what it does not do.

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

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

Explicitly states when to use (for concise explanation of a known symbol) and when not to use, listing three specific alternatives: get_symbol_context for comprehensive context, search_symbols for fuzzy search, get_references for cross-reference tracing.

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