listWorkspaceVolumesRetrieve storage volumes for a workspace to inspect attached disks and their configurations. Specify workspace slug to list volumes across environments or regions.
List storage volumes in workspace
| Name | Required | Description | Default |
|---|---|---|---|
| env | No | ||
| region | No | ||
| workspaceSlug | Yes |
Changes observed during successful MCP inspections.
v0.5.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The readOnlyHint and destructiveHint annotations indicate no destructive side effects, and the description's 'list' wording aligns with read-only behavior. No additional side-effect disclosure is needed, though it doesn't mention output behavior.
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 words and directly states the operation and scope.
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?
Adequate for a simple listing operation, but it omits details such as whether env/region are required filters, possible response format, or how this differs from the sibling listVolumes tool.
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?
The schema has no parameter descriptions and the tool description only clarifies workspaceSlug via 'in workspace'. The env and region parameters are not explained, so the description does not compensate for the low schema coverage.
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 the resource (storage volumes) and action (list), and clarifies the scope as workspace. It does not explicitly differentiate from the sibling listVolumes tool, but the workspace qualifier provides enough purpose.
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?
No guidance is given on when to use this tool versus alternatives like listVolumes or how to combine env/region filters. The description only states what it lists, not when it should be chosen.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.