Skip to main content
Glama
MCP Dokploy Online
by igoruam

settings-saveSSHPrivateKey

Idempotent

Stores an SSH private key in Dokploy settings for authenticating deployments and infrastructure connections to remote servers.

Instructions

POST /settings.saveSSHPrivateKey

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": {
      "sshPrivateKey": "<sshPrivateKey>"
    },
    "name": "settings-saveSSHPrivateKey"
  }
}

Input Schema

NameRequiredDescriptionDefault
sshPrivateKeyYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.3/5.0
Behavior1/5

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

Annotations declare openWorldHint=true and idempotentHint=true, but the description adds nothing about what the save overwrites, whether an existing key is replaced, what permissions or authentication are required, or how the sensitive credential is handled. For a write of a private key, this is a serious disclosure gap.

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, but brevity here comes from under-specification rather than efficiency; the single route string conveys no information beyond the name and is not front-loaded with purpose or scope.

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?

For a mutation that stores a sensitive credential, with no output schema, no parameter documentation, and only sparse annotations, the definition omits everything an agent needs: effect on existing keys, error behavior, and confirmation semantics.

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

Parameters1/5

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

There is one required parameter, sshPrivateKey, with 0% schema description coverage, and the description says nothing about its format, expected encoding (PEM/OpenSSH), or constraints. The description therefore fails to compensate for the schema 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 a restatement of the tool name as an HTTP route ("POST /settings.saveSSHPrivateKey"). It implies storing an SSH private key in settings, but gives no verb+resource phrasing an agent can act on and does not distinguish it from the sibling settings-cleanSSHPrivateKey or the sshKey-* family.

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

Usage Guidelines1/5

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

There is no when-to-use guidance, no prerequisites, and no mention of alternatives such as sshKey-create or settings-cleanSSHPrivateKey. The agent must infer entirely from the tool name when this endpoint should be called.

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