Refine Query Session SQL

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

No annotations are provided, so the description carries the full burden. It mentions 'read-only' and 'without executing it,' which is good, but it does not disclose whether the tool modifies the session (despite an updateSession parameter), permissions required, or state changes. This leaves several behavioral aspects unclear.

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 of 18 words, front-loaded with the core action and constraints. No redundant or filler content; every part adds value.

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 10 parameters and no output schema or annotations, the description lacks detail on return values (presumably the SQL string), the role of profile, and the behavior of updateSession. It covers the primary purpose but leaves gaps for a complete understanding of the tool's capabilities.

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%, so the description must compensate. It covers columns, filters, ordering, and pagination (page, pageSize) but omits explanation of profile, addColumns, updateSession, and keepExistingColumns. Seven out of ten parameters lack any context in the description, leaving the agent to infer their purposes.

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 builds a refined read-only SELECT from a query session without executing it, listing structured columns, filters, ordering, and pagination. It distinguishes itself from sibling tools like ob_query (which executes) and ob_build_select (which likely executes) by emphasizing no execution.

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 the tool is used after a query session is started and for building a refined query without execution, but it does not explicitly state when to use it over alternatives like ob_build_select or ob_prepare_query. No exclusions or prerequisites beyond requiring a sessionId.

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