Preview Read-only Query

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

With no annotations, the description carries full burden. It clearly discloses the tool is read-only and does not execute the query. However, it does not mention required permissions, potential side effects on policy evaluation, or the nature of the preview output. Still, the core behavioral trait is transparent.

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 sentence that immediately conveys the tool's purpose and key constraint. Every word earns its place; no redundancy or filler. It is well front-loaded with the action 'Preview'.

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?

Given 4 parameters, no output schema, no annotations, and 29 siblings, the description is too brief. It does not explain return values, parameter details, or comparison to siblings like ob_explain. An agent would lack sufficient context to use the tool correctly, especially for parameters like 'profile' and 'maxRows'.

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 description coverage is 0%, and the description adds no information about the 4 parameters (sql, params, maxRows, profile). The agent receives no guidance on how to use these parameters, e.g., that 'sql' must be a SELECT statement, or the purpose of 'profile'. The description fails to compensate for the missing 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 previews policy, sensitive-column, and EXPLAIN risk for a read-only SQL statement, specifying it does not execute the query, which distinguishes it from execution siblings like ob_query. The verb 'preview' and resource 'read-only SQL statement' are specific and unique among siblings.

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 for assessing risks before executing a query by stating 'without executing the target query', but it does not explicitly state when to use this tool vs alternatives like ob_explain or ob_analyze_query_plan. No exclusionary guidance or alternative names are provided.

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