Skip to main content
Glama
Cloady

Cloady

Official
by Cloady

Get Volume Keys

getVolumeKeys
Read-only

Retrieves S3 and SFTP credentials for a specified volume or service filesystem, using the volume name and kind to return stable, derived access credentials.

Instructions

Get S3 and SFTP credentials for one volume or service filesystem. Derived, not stored, so they are stable and need no rotation step. volume is a name from listVolumes; kind selects a persistent volume (default) or a service filesystem.

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": {
      "workspaceSlug": "<workspaceSlug>",
      "appSlug": "<appSlug>",
      "volume": "<volume>"
    },
    "name": "getVolumeKeys"
  }
}

Input Schema

NameRequiredDescriptionDefault
envNo
kindNo
regionNo
volumeYes
appSlugYes
workspaceSlugYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.18.0
    • addedInput schema / properties / kind
      Added value: +{
      +  "enum": [
      +    "service",
      +    "volume"
      +  ],
      +  "type": "string"
      +}
  2. First observedv0.5.1

TDQS

A4.1/5.0
Behavior4/5

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

The annotations already establish that this is a safe, non-destructive read (readOnlyHint=true, destructiveHint=false). The description adds useful behavior beyond that: the credentials are 'derived, not stored, so they are stable and need no rotation step.' That tells the agent credentials remain valid and do not require a refresh flow. It does not describe whether access is scoped or time-limited, which would have been the final piece.

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?

Three short sentences: purpose first, the operational reassurance second, then parameter guidance. No filler, no repetition of the title, and each sentence carries distinct information.

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

Completeness3/5

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

There is no output schema, and the description only says the result is S3 and SFTP credentials. It does not say whether the response contains separate key/secret pairs per protocol, whether the credentials come with endpoint or bucket details, or what a missing volume returns. Combined with four undocumented input parameters, gaps remain for a six-parameter tool.

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

Parameters3/5

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

Schema description coverage is 0%, so the description must carry the parameter burden. It documents `volume` with a source ('a name from listVolumes') and `kind` with enum meaning and default. Four parameters (`workspaceSlug`, `appSlug`, `env`, `region`) are left entirely uninterpreted. The description adds real meaning for the two parameters most likely to be misused but falls short of full coverage.

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?

The description opens with a specific verb and resource: 'Get S3 and SFTP credentials for one volume or service filesystem.' This clearly separates it from sibling credential tools such as getDbCredentials and from listVolumes, so an agent can identify the correct tool without opening the schema.

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?

It gives a concrete prerequisite: '`volume` is a name from listVolumes,' which tells the agent which sibling to call first. It also explains that `kind` selects a persistent volume by default or a service filesystem. It stops short of naming conditions where this tool should not be used, such as non-S3 backends.

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

Deploy Server

Other Tools