collect_rsi

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

Mentions model-specific timeouts (e.g., SRX Branch: 1200s) and that it saves two files. However, with no annotations provided, it does not disclose other important behaviors such as whether it modifies the device, authentication requirements, or error handling.

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?

Description is concise with a clear overview and a structured Args section. No superfluous text, though the Args list could be slightly more integrated.

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 and many sibling tools, the description covers the core functionality and parameter context. However, it lacks guidance on error scenarios, and the behavioral transparency is incomplete, making it adequate but not fully comprehensive.

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?

Each parameter is explained beyond the schema: hostname must exist in config.ini, output_dir defaults to config RSI_DIR or current dir, config_path defaults to empty string for default search. This adds significant value given 0% schema coverage.

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?

Clearly states it collects RSI and SCF from a device and saves two files. The name and description imply a single-device operation, but it does not explicitly differentiate from the sibling tool 'collect_rsi_batch'.

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?

Provides a prerequisite (hostname must exist in config.ini) but offers no guidance on when to use this tool versus alternatives like 'collect_rsi_batch' or other diagnostic tools.

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