Skip to main content
Glama

List volumes

volume_list
Read-onlyIdempotent

List a project's persistent sandbox volumes with name, id, size, status, region, and usage, or show the volume attached to a specific app and its mount path.

Instructions

Use this when the user wants to see persistent volumes. Without service: the project's sandbox volumes — name, id, size (sizeGb), status, region, how much is used (lastUsedBytes), and the sandbox it is attached to, if any. With service: the volume attached to that app and where it is mounted.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project": "<project>"
    },
    "name": "volume_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
projectYesProject name, slug, or ID
serviceNoAn app name or ID: list its volume instead

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.3
    • addedInput schema / properties / service
      Added value: +{
      +  "description": "An app name or ID: list its volume instead",
      +  "minLength": 1,
      +  "type": "string"
      +}
  2. Addedv0.1.2

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already establish that this is a safe, idempotent read operation. The description adds useful behavioral detail beyond annotations: it lists the returned fields and explains that supplying 'service' changes the query from all sandbox volumes to a specific app volume and mount location.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is short, front-loaded with the usage trigger, and then immediately explains the two operational modes and the returned data. Every sentence carries information needed to invoke or interpret the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, so the description appropriately names the important return fields (name, id, sizeGb, status, region, lastUsedBytes, attached sandbox). It is nearly complete for a simple read-only list tool, though it does not discuss pagination, empty results, or error cases.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so both parameters are already documented. The description still adds semantic value by clarifying the meaning of the optional 'service' parameter: without it, the tool lists project sandbox volumes; with it, the tool returns the volume attached to that app and where it is mounted.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('see persistent volumes') and explains the two scopes: project sandbox volumes by default, or the volume attached to a given app when 'service' is supplied. This is specific enough to distinguish it from volume_create, volume_resize, and volume_delete.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives a clear trigger ('Use this when the user wants to see persistent volumes') and explains the branch between omitting and supplying 'service'. It does not name alternatives or exclusions, but the usage context is explicit.

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