Collect diagnostics by key

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

In the absence of annotations, the description discloses key behaviors: commands are whitelisted (limited to up to 8), output is redacted and truncated, and invalid keys are rejected. No contradictions; it provides a clear safety profile for a read-like diagnostic tool.

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 two concise sentences, front-loading the core action and constraints. Every sentence adds information without redundancy.

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 no annotations or output schema, the description covers core behavior and constraints but lacks details on output format or structure. For a tool with multiple parameters, more clarity on return values 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?

The schema has 100% coverage with descriptions for all three parameters. The description adds value by linking keys to the whitelist and explaining the maxItems constraint (up to 8), which enhances schema meaning.

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 title 'Collect diagnostics by key' and description explicitly state it runs up to 8 whitelisted commands on a host and returns redacted/truncated output. It distinguishes itself from siblings like get_whitelist and collect_base by focusing on running commands vs listing keys or base collection.

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 using get_whitelist to see valid keys and states that invalid keys are rejected, guiding proper use. However, it does not explicitly state when not to use this tool or provide alternatives for related tasks.

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