Explain SQL Error

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

Discloses that the tool does not execute SQL and includes policy context and metadata hints, but lacks detail on return format, limitations, or side effects; with no annotations, the coverage is moderate.

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, no redundancy, but overly terse; could be more structured to include key aspects without being verbose.

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?

Lacks output description, error handling, and parameter details; insufficient for a tool with no output schema and 5 parameters.

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?

With 0% schema description coverage and no parameter information in the description, the agent receives no additional meaning beyond the raw schema fields.

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 SQL error with policy context and metadata hints, and distinguishes it from siblings like ob_explain and ob_policy_explain by specifying it does not execute SQL.

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 explicit guidance on when to use this tool versus alternatives like ob_policy_explain or ob_lint_sql; the description only implies usage for error explanation without execution.

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