lcm_inventory

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

With no annotations, the description carries full burden. It explicitly labels the tool as [READ], indicating it is non-destructive. It also discloses the limit parameter's behavior (reporting returned, limit, truncated) for transparency on capped reads. However, it does not mention auth requirements or potential side effects.

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 extremely concise, with one line for purpose and two lines for parameters. Every sentence serves a clear function, and the purpose is front-loaded. No unnecessary information.

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 simple read tool with two parameters and no output schema, the description covers the key aspects: what is listed, parameter behaviors, and result reporting. It could optionally mention that the result is a list, but the context is sufficient.

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 0%, so the description must compensate. It provides clear meanings: limit explains max rows, default, and reporting behavior; target explains it's a Prism Central target name from config. This adds significant value beyond the schema.

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 starts with '[READ] List LCM-managed entities: current/available versions and updateAvailable.' It clearly states it's a read operation, specifies what it lists (entities, versions, updateAvailable), and distinguishes itself from sibling tools like lcm_update and lcm_precheck.

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 the tool is for listing inventory but does not explicitly state when to use it versus alternatives like lcm_precheck or lcm_update. No mention of when not to use or context for selection.

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