coolify-mcp

Get private key

getPrivateKey

Read-only

Retrieve SSH private key metadata by UUID. Use showSecrets to unmask the private key material when needed.

Instructions

Get an SSH private key's metadata by UUID. The key material is masked unless showSecrets is true.

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": {
      "uuid": "<uuid>"
    },
    "name": "getPrivateKey"
  }
}

Input Schema

Name	Required	Description	Default
`uuid`	Yes
`showSecrets`	No

Schema Changelog

Changes observed during successful MCP inspections.

Addedv0.1.5Aug 7, 2026

TDQS

A4.2/5.0

Behavior4/5

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

Annotations already declare readOnlyHint and openWorldHint, so the description adds valuable context by disclosing that key material is masked unless showSecrets is true. This behavioral detail is not present in annotations and helps the agent understand the output masking behavior. No contradiction with annotations.

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 two concise sentences, front-loaded with the exact purpose and then adding a key behavioral note. Every word earns its place; no redundancy or filler.

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?

Without an output schema, the description adequately explains the return concept (metadata) and the masking behavior. It does not describe error cases or full return fields, but for a simple get-by-UUID tool with one optional boolean, the provided context is sufficient for correct invocation.

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 description coverage is 0%, so the description must compensate. It explains that 'uuid' is the identifier of the private key ('by UUID') and clearly ties 'showSecrets' to the masking behavior. Both parameters receive semantic context, though the description could elaborate on the format or expected values.

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 uses a specific verb 'Get' and clearly identifies the resource as 'SSH private key's metadata' with a UUID identifier, distinguishing it from sibling tools like listPrivateKeys (which lists all) or create/update/delete mutations. The scope is unambiguous.

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

Usage Guidelines3/5

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

The description implies the tool is used when you have a UUID to fetch a single private key's metadata, but it does not explicitly compare with alternatives like listPrivateKeys or mention when not to use it. The usage context is clear from the verb and identifier but lacks explicit exclusion or alternative guidance.

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

Deploy Server