Generate Query Examples

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

The description discloses read-only and non-execution behavior, but with no annotations, it lacks detail on other behavioral traits like rate limits, permission needs, or error handling.

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 that is concise and front-loaded with the key action. However, it could be more structured for readability.

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 description is too brief given the tool's complexity (6 parameters, no output schema). It does not explain what the generated examples look like, how scenarios affect output, or what the return format is.

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 provides no clarification on any of the 6 parameters (table, schema, maxRows, profile, scenarios, maxColumns). The agent gets no help beyond the schema definition.

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 it generates scenario-based read-only SQL examples from policy-filtered table metadata without executing them. This distinguishes it from sibling tools like ob_generate_query which may execute or generate different types.

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. It does not specify conditions or exclusions, leaving the agent to infer from the description alone.

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