collect_rsi

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

Though no annotations are provided, the description discloses key behaviors: saving two files with specific naming, automatic model-specific timeouts, and default parameters. It does not mention whether the operation is safe/read-only or any potential side effects, but for a collection tool these are reasonable.

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 concise and well-structured, starting with the purpose, then detailing output and arguments. It avoids unnecessary words while providing essential information.

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's moderate complexity (3 parameters, output schema exists), the description covers the core functionality, output, and special behavior (timeouts). It does not detail the return structure (but output schema may do so) or error cases, but is largely complete for effective use.

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 no descriptions (0% coverage), but the description explains each parameter beyond its name: hostname must exist in config.ini, output_dir defaults, config_path defaults. This adds significant meaning, though some details (e.g., hostname validation) are omitted.

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 collects RSI and SCF from a device, identifies the output files, and distinguishes it from batch operations. It uses a specific verb ('Collect') and names the resources (RSI, SCF), making the purpose unambiguous.

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 is provided on when to use this tool versus its sibling tools like 'collect_rsi_batch' or other diagnostic tools. The description implies it's for a single device but does not state prerequisites or scenarios.

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