Skip to main content
Glama
MCP Dokploy Online
by igoruam

dockerVolume-getVolumeConfig

Read-onlyIdempotent

Retrieves the configuration of a Docker volume by name from a Dokploy instance, optionally targeting a specific server, so you can inspect its settings before managing it.

Instructions

GET /dockerVolume.getVolumeConfig

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": {
      "volumeName": "<volumeName>"
    },
    "name": "dockerVolume-getVolumeConfig"
  }
}

Input Schema

NameRequiredDescriptionDefault
serverIdNo
volumeNameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.9/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and openWorldHint=true, so the safety profile is covered structurally; the description adds nothing about behavior, authentication scope, or what configuration is returned. 'GET' is consistent with readOnlyHint, so there is no contradiction, but there is also no added value beyond the annotations.

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

Conciseness2/5

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

It is short with no wasted words, but this is under-specification rather than conciseness: the single route string carries no explanatory content and is not front-loaded with useful information.

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

Completeness1/5

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

With two parameters, zero schema description coverage, and no output schema, the description is the only place semantics could be conveyed and it conveys none. An agent cannot determine what the returned configuration contains or how the required volumeName is used in context.

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

Parameters2/5

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

Schema description coverage is 0% and the description mentions neither volumeName nor serverId. The schema constrains volumeName with a pattern and minLength but leaves serverId entirely untyped in meaning, and the description does nothing to compensate for that gap.

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

Purpose2/5

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

The description is only the raw route 'GET /dockerVolume.getVolumeConfig', which restates the tool name and HTTP verb rather than stating in plain terms what configuration is retrieved. An agent can infer it is a read of some volume config, but it cannot tell from the text how this differs from siblings like dockerVolume-getVolumes or dockerVolume-getVolumesSize.

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

Usage Guidelines2/5

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

No when-to-use, when-not-to-use, or prerequisite guidance is provided. The 'GET' verb implies a read operation but does not indicate whether a serverId is needed in multi-server setups or when to prefer getVolumes over this tool.

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