Check Data Quality

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

Without annotations, the description must disclose behavior. It states the tool is 'read-only' and 'bounded', which is helpful. However, it does not explain what output is returned, whether checks are run as a SQL query, or any potential performance impacts or limitations like the row limit or maximum columns.

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, concise sentence (16 words) that front-loads the action and context. No redundant or filler content.

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 7 parameters, no output schema, no annotations, and many sibling tools for data profiling and analysis, the description is insufficiently complete. It does not explain return values, how to interpret results, or what happens when parameters are omitted. The agent would need additional knowledge to use the tool effectively.

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 mentions the types of checks but does not explain the purpose of any of the 7 parameters (e.g., `profile`, `nullRatioThreshold`, `columns`). This leaves the agent without guidance on how to set parameters correctly.

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 specifies the verb 'run' and the resource 'data quality checks', and enumerates the types of checks (nulls, duplicate key risk, dimensions, time columns). This provides clear purpose and sets it apart from sibling tools that focus on other operations like profiling or sampling.

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 states the tool is 'bounded read-only', implying safety, but it does not explicitly indicate when to use this tool over alternatives like `ob_profile_table` or `ob_detect_dimension_columns`. No when-not or exclusion criteria are provided.

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