createSshSessionCreate short-lived SSH credentials to access a running container on Cloady. Specify workspace, app, and component for a temporary session.
Create a short-lived SSH session credential for a running container
| Name | Required | Description | Default |
|---|---|---|---|
| env | No | ||
| region | No | ||
| appSlug | Yes | ||
| requestBody | No | The JSON request body. | |
| workspaceSlug | Yes |
Changes observed during successful MCP inspections.
v0.5.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description adds the trait 'short-lived' but does not explain side effects, authentication requirements, or potential failures. Annotations already indicate it is non-read-only and destructive, but the description offers no additional context beyond that.
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 clear sentence with no unnecessary fluff. It is appropriately concise and front-loaded with the core action.
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?
The tool is missing essential contextual information: no output schema, no description of return values, no parameter explanations beyond one generic field, and no guidance on expected behavior or failure modes. Given the complexity of the input schema and the range of sibling tools, the description is significantly under-specified.
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?
Only the requestBody parameter has a description, which is generic ('The JSON request body') and does not explain its nested component field. The other four parameters (env, region, appSlug, workspaceSlug) are completely undocumented, leaving the schema largely unexplained.
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 clearly states the tool's action: creating a short-lived SSH session credential for a running container. It uses a specific verb and resource, and it is distinct from sibling tools like createS3Session.
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 gives no explicit guidance on when to use this tool versus alternatives. It does not mention prerequisites, such as needing a running container, nor does it differentiate from execCommand or other remote-access tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.