pack_diagnose

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

The description discloses the two core behaviors (find and checksum-verify), implying a read-only diagnostic operation. However, it does not mention side effects, failure modes, requirements, or what happens on checksum mismatch. With no annotations, the description carries the full burden but only covers basic behavior.

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 that is efficiently front-loaded with action verbs. No filler words or redundant information, every word contributes to clarity.

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, no output schema, and only 2 parameters, the description is too terse for complete invocation. It leaves out the role of search_roots, the meaning of 'managed', and what the tool returns. This is insufficient for an agent to confidently use 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?

The schema has 0% description coverage. The description mentions 'target' (for a target) providing minimal meaning for that parameter, but 'search_roots' is completely unexplained. The description does not compensate for the missing schema descriptions.

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 uses specific verbs 'find' and 'checksum-verify' with a clear resource: 'managed CMSIS-Pack for a target.' It clearly distinguishes from sibling tools like pack_install by focusing on verification rather than installation.

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?

There is no guidance on when to use this tool vs alternatives such as pack_install or pack management. No context, exclusions, or alternative suggestions are provided, leaving the agent to infer appropriate usage.

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