generate_sbom

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

Discloses output format (CycloneDX 1.5), included fields, and validation step. Lacks details on potential network access, performance impact, or any side effects, but adequate for a read-only generation 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?

Two sentences, front-loaded with main action, no redundant words. Efficient and clear.

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?

Missing explicit return value or output format (e.g., JSON/XML). No output schema to compensate. Does not explain repoRoot parameter's role or constraints.

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?

No description adds meaning to the two parameters. Schema provides type/enum only; repoRoot has no explanation of its purpose or semantics. With 0% coverage, description fails to compensate.

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?

Clear verb 'Build' and resource 'CycloneDX 1.5 SBOM for the repository' with specific format and component details. Distinct from siblings like audit_dependencies and scan_repository.

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?

Implies use when needing an SBOM, but no explicit guidance on when to use this vs. alternatives like audit_dependencies or scan_repository. No exclusions or prerequisites mentioned.

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