dq-list-checks

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

No annotations provided, so description carries full burden. Mentions 'recent rows' but doesn't clarify default time window or explain that it's a read-only operation. Lacks details on authorization or performance.

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, focused, no unnecessary words. Could include more detail but remains efficient.

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 6 parameters, no output schema, and no annotations, the description is minimal. It does not explain return format, pagination, or the meaning of 'recent' beyond the sinceHours parameter.

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 coverage is 67% (4/6 parameters described). Description adds context that filters apply to DQ_RESULTS_TABLE, but does not significantly expand on parameters like limit or sinceHours beyond defaults.

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?

Description clearly states it lists recent rows from DQ_RESULTS_TABLE with filters by dataset, status, type, and time window. It distinguishes from siblings like dq-failed-checks-by-dataset and dq-get-check-history.

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?

Implies usage for listing recent checks with filters, but no explicit when-to-use or when-not-to-use compared to siblings like dq-failed-checks-by-dataset or dq-get-check-history.

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