Generate CycloneDX SBOM

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

Annotations already provide readOnlyHint, idempotentHint, and destructiveHint, which cover safety. The description adds context by specifying the exact SBOM standard version (CycloneDX 1.6) and the input restriction that only lockfiles with resolved versions are accepted.

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 the core function, followed by a key constraint. 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?

For a tool that generates an SBOM, the description specifies the input constraints and output format standard. There is no output schema but the return value is implied. Adequate for the tool's simplicity, though lacks details on error handling or output location.

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 description coverage is 50% (parameters filename and content have descriptions). The description adds meaning by explaining that filename is used to detect format and content is lockfile contents. However, appName and appVersion are not explained, so the description does not fully compensate for the low 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?

The description clearly states the tool produces a CycloneDX 1.6 SBOM from specific lockfiles, using a specific verb 'Produce' and resource 'SBOM', and distinguishes it from sibling tools that deal with robot model conversions.

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 implies when to use (when you have a lockfile and need an SBOM) and lists acceptable lockfile formats, but does not provide explicit when-not-to-use or alternatives. The constraint 'Manifests without resolved versions are refused' is a limitation, not usage guidance.

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