vast42_list_companions

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

The description says 'List all' but the input schema includes a default limit of 100 and a max of 100, implying the tool is paginated and may not return all records in a single call. This pagination behavior is not disclosed, and with no annotations, the description carries full responsibility for behavioral transparency but falls short.

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 with no redundancy or fluff. It is appropriately sized for a simple list operation and every word contributes to the meaning.

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 tool with no annotations and no output schema, the description should at least mention pagination behavior, clarify what 'all' means given the limit parameter, and indicate that it returns a list of companion resources. The current one-liner is too terse to give an agent a complete understanding of the tool's behavior.

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 coverage is 100% with clear descriptions for limit and offset ('Max results to return (default 100, max 100)' and 'Pagination offset'). The description adds no additional parameter meaning, so the baseline of 3 is appropriate.

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 'List all VAST 4.2 companions' clearly states the action (list), the resource (VAST 4.2 companions), and the scope (all). The version qualifier '4.2' helps differentiate it from the sibling tool vast_list_companions, though it does not explicitly name the alternative.

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 provides no guidance on when to use this tool versus alternatives like vast_list_companions or other listing tools. There is no mention of use cases, exclusions, or contexts where this tool is preferred.

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