Explain Project Query

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

Discloses read-only nature and that it does not execute, but fails to explain the role of key parameters like runExplain, maxRows, params, or the meaning of 'explain' output. With no annotations, more detail is needed.

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?

Single sentence is concise and front-loads the core action, but the brevity sacrifices necessary detail for a tool with 8 parameters.

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?

With no output schema, 0% parameter coverage, and many sibling tools, the description is far too sparse. It leaves the agent guessing about input formats, output, and when to use this tool.

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?

Schema coverage is 0%, yet the description adds no parameter information beyond hinting at 'sql' and 'filePath'. 8 parameters remain undefined, leaving the agent without guidance on how to use them.

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 explains a read-only SQL snippet, specifying it can come from text or a local project file. It distinguishes from related tools like ob_analyze_query_plan by mentioning the source, but does not explicitly differentiate from ob_explain.

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?

No guidance on when to use this tool versus alternatives like ob_explain or ob_analyze_query_plan. The description only states what it does, not when to choose it.

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