Get Cube SSH Info

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

Annotations already mark the tool as read-only, and the description adds meaningful behavioral context: the returned user varies by Cube age/image, has passwordless sudo, and `sudo su` reaches root. This tells the agent important post-call expectations beyond what the annotations convey.

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 compact and front-loaded: the first sentence states what the tool returns, the second gives the usage directive, and the third adds important privilege context. Every sentence earns its place with no repetition or filler.

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?

Even without an output schema, the description explains the return contents well enough for an agent to know what to expect: host, port, login user, and pinned host keys. It also covers the tricky username-derivation case and the sudo behavior, so the tool is fully usable from the description alone.

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 100%, so both cubeId and spaceId are already documented in the schema itself. The description adds no additional parameter-level meaning, making the baseline score of 3 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 states a specific action and resource: getting everything needed to SSH into a Cube, and enumerates the exact contents (host, port, login USER, pinned host keys). It clearly distinguishes itself from sibling cube operations like get_cube or power_off_cube by focusing on SSH credentials and connection details.

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 explicitly says 'Call this rather than guessing a username' and explains why the username cannot be derived from the image id, offering strong contextual guidance. It does not discuss alternative sibling tools, but no sibling appears to provide the same SSH-info function, so the guidance is sufficiently clear.

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