Analytics Query

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

Annotations already mark it as read-only, non-destructive, idempotent, and open-world. The description adds crucial behavioral context: it requires an environment variable and silently returns empty results if ClickHouse is unavailable. This goes beyond what annotations provide.

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?

Two sentences, no filler. The first sentence states the core purpose, and the second provides a critical prerequisite and fallback behavior. Every word earns its place.

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 the existence of an output schema (not shown but noted), the description covers purpose, prerequisite, and failure behavior. With thorough annotations, no additional information is needed.

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 100%, so the schema already fully documents all 5 parameters. The description does not add new parameter-specific details beyond what is in the schema; it merely restates that certain parameters are used by certain query types, which is already in the parameter 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 queries vulnerability trends, posture history, and runtime event summaries from ClickHouse. It specifies the resource (ClickHouse) and the verb (query), and it distinguishes itself from sibling tools which are specific scan or analysis tools, as there is no other query tool for analytics.

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 mentions the prerequisite that AGENT_BOM_CLICKHOUSE_URL must be set and that empty results are returned if not configured. While it does not explicitly compare to alternatives, the sibling list contains no other analytics query tool, making usage context clear.

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