query_system_updates

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

With no annotations provided, the description fully bears the burden of behavioral disclosure. It details pagination behavior (limit <=0 returns no items, positive limit capped at 200), input resolution via another tool, and return structure (updates and meta).

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 informative and reasonably concise, around 100 words. It starts with the core purpose and flows logically into inputs, then a usage note, then pagination behavior. Could benefit from slight restructuring for easier scanning (e.g., bullet points), but overall effective.

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 tool has 5 parameters and an output schema, the description covers inputs, pagination behavior, and return structure. It mentions the output schema indirectly. It does not cover error cases or edge cases beyond pagination, but the output schema likely covers the return format.

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?

The input schema has 0% description coverage, so the description must compensate. It explains each parameter: system_identifier (name or id), limit, offset, include_cves, advisory_types. It also explains the effect of limit and offset, providing meaning well beyond the raw schema.

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 pending updates for one system. It uses a specific verb ('Query') and resource ('pending updates'), and the context distinguishes it from sibling tools like check_all_systems_for_updates (which handles all systems).

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 provides guidance on when to use this tool, including resolving system names via find_systems_by_name and noting it is best for pagination and optional CVE expansion. However, it does not explicitly contrast with every sibling (e.g., get_system_updates), so it is clear but not exhaustive.

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