tickory_update_scan

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

No annotations are provided, so the description must disclose behavioral traits. It states 'Replace' but does not mention side effects (e.g., whether the old scan is deleted), authorization needs, or behavior if the scan_id does not exist. For a mutation tool, this is insufficient.

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 sentence (14 words), which is concise but lacks necessary detail. It could be expanded to include key constraints (e.g., user ownership) and still remain reasonably concise.

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 complexity (7 parameters, nested objects, and an output schema exists), the description is too sparse. It does not explain the return value or provide examples, making it incomplete for an agent to correctly invoke the tool.

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 86%, so the schema already documents most parameters. The description adds little beyond 'including timeframe', which is already in the schema. Baseline 3 is appropriate as the description does not significantly enhance understanding.

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 action ('Replace an existing user-owned scan') and the resource ('scan'). It distinguishes from siblings like tickory_create_scan by indicating it's an update operation, and from tickory_run_scan by implying persistent modification.

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 passing the full desired scan state, implying a full replacement rather than partial update. However, it does not explicitly state when to use this tool versus alternatives like tickory_create_scan, nor does it provide guidance on prerequisites or when not to use it.

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