tickory_run_scan

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

No annotations provided, so description bears full burden. It only states 'run immediately' but does not disclose side effects (e.g., does it modify state?), authorization needs, rate limits, or whether the operation is synchronous or potentially long-running.

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, no redundancy, front-loaded with the core action and result. 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 presence of an output schema, the description covers the return type but lacks detail on execution behavior (e.g., is it real-time or queued?). With 16 siblings, more context about the role of 'run_scan' relative to 'get_scan' or 'run_ad_hoc_scan' would improve completeness.

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?

With 50% schema description coverage, the description adds no extra meaning beyond the schema. It does not explain what the scan_id refers to, what 'symbols' overrides, or how they affect results. The description alone is insufficient for an agent to understand parameter usage.

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 that the tool runs a scan immediately and returns results, specifying the verb (run) and resource (scan). It distinguishes from siblings like 'tickory_get_scan' and 'tickory_run_ad_hoc_scan' by implying it uses a predefined scan_id.

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?

No explicit guidance on when to use this tool vs alternatives, such as 'tickory_run_ad_hoc_scan' or 'tickory_get_scan'. It does not mention prerequisites, context, or exclusions.

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