pgroonga_explain_search

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

With no annotations, the description discloses that the tool is non-executing and returns JSON format, which is a key behavioral trait. However, it does not disclose side effects, permissions, validation behavior, or error conditions, leaving some gaps in the transparency.

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?

The description is a single concise sentence that is front-loaded with the key distinction 'non-executing.' It contains no filler and is appropriately minimal, making it easy to parse.

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?

The tool has a complex schema with nested objects and multiple modes, yet the description gives no context about how parameters interact or what constitutes a valid search. The output schema exists, but the description remains insufficient for an agent to construct a correct request.

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?

The description provides zero information about the 8 parameters, and schema coverage is 0%. The schema itself has enums and defaults, but the description adds no meaning beyond the field names, failing to compensate for the lack of schema descriptions.

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?

The description clearly states the tool returns a non-executing EXPLAIN (FORMAT JSON) for a validated search, which distinguishes it from pgroonga_search that likely executes the search. The verb 'Return' plus the resource 'EXPLAIN (FORMAT JSON)' make the purpose specific and unambiguous.

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?

The description implies usage via the phrase 'non-executing' but does not explicitly state when to use this tool instead of pgroonga_search, nor provide alternative guidance. It suggests using it to preview the plan, but lacks explicit when-to-use or when-not-to-use instructions.

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