get_sbom

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

With no annotations, the description carries the full burden but only says 'Read', implying a safe operation. It does not disclose authentication requirements, side effects, or what happens if the SBOM or application is not found.

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, concise and to the point. It efficiently conveys the core functionality without unnecessary words. However, there is room for slightly more structure (e.g., separating the two cases).

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?

The tool has no output schema, two undocumented parameters, and no annotations. The description only covers the basic purpose, missing details about parameter usage, return value, and prerequisites like actuator exposure. This is insufficient for full context.

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 coverage is 0%, and the description does not explain the purpose of the 'application' parameter at all. The 'sbom_id' parameter is implied by the description but not explicitly described. This leaves the agent guessing.

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 reads /actuator/sbom or a specific SBOM by id, distinguishing it from other actuator tools that deal with different endpoints. However, it does not explain what 'SBOM' stands for, which is minor given the context.

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?

No guidance is provided on when to use this tool versus its siblings. The description only states what it does without any contextual cues for when it is appropriate.

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