get_inventory_references

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false, so the description is not required to re-state safety; it adds nothing beyond that. It does not mention whether the result is a list, whether references are paginated, or what an empty inventory looks like.

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?

It is short and front-loaded, which is good, but the brevity comes from under-specification rather than economy of wording. Every token past the tool name is redundant with the schema.

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?

With no output schema, no annotation-derived return info, and 0% parameter documentation, the description leaves the agent unable to predict the response shape or confirm it is the right tool. For a reference-lookup endpoint in a large API surface, this is inadequate.

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 both required integer parameters (project_id, inventory_id) are undocumented anywhere. The embedded path hints they are path parameters and scopes the lookup to a project and inventory, but it adds no format, valid-range, or error behavior detail.

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?

"Get Inventory Refs" essentially restates the tool name, and the appended REST path gives only the location, not the meaning. It never says what an inventory "reference" is (templates? workflows? attached objects?) or what the tool returns, so an agent cannot distinguish it from get_inventory on substance.

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?

There is no when-to-use guidance, no distinction from the nearby get_inventory or the family of other *_references tools, and no stated prerequisites (e.g., that the inventory must exist or be readable). The agent must guess.

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