generate_cbom

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

Discloses filesystem reading and HTTP gating similar to 'scan_path'. No annotations exist, so description carries burden and does well, though lacks details on side effects or limits.

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?

Two sentences, front-loaded with purpose and output, second adds behavioral context. No wasted words.

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?

Covers purpose, output format, access gating, and parameter. Lacks detail on 'classical cryptographic assets' and CBOM specifics, but sufficient for agent decision given low complexity.

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?

Schema has 100% coverage for single 'path' parameter with description. Description adds context by specifying scanning action and file/directory, but schema already defines it.

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?

Specifies verb 'scan', resource 'path', and output 'CycloneDX 1.6 CBOM' for compliance/supply-chain tooling. Distinguishes from sibling 'scan_path' by noting similar gating.

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 context 'for compliance / supply-chain tooling' but does not explicitly state when not to use or list alternatives among siblings.

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