list_terraform_aliases

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

Annotations already declare read-only, idempotent, open-world, non-destructive behavior. The description adds valuable caveats about edition, license, permissions, and Community 404/empty-list responses that are not captured by annotations.

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 short and front-loads the purpose. The availability caveat and endpoint are useful, though the typo 'aliass' and raw endpoint notation slightly reduce polish.

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-only list endpoint with rich annotations and no output schema, the description covers purpose, access caveats, and the route. It could do more on parameter meaning or pagination, but it is largely 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 should compensate. It does so only partially by exposing the GET path with project_id and inventory_id as path parameters, but it does not explain their meaning or constraints beyond their names.

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 states a specific verb and resource: listing Terraform aliases. This is clearly distinct from siblings such as get_terraform_alias, create_terraform_alias, and list_terraform_states.

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 notes availability constraints and possible 404/empty-list responses, which helps set expectations. However, it does not explicitly say when to use this tool instead of get_terraform_alias or how it relates to list_terraform_states.

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