Skip to main content
Glama
MCP Dokploy Online
by igoruam

user-createApiKey

Create a user API key with organization metadata and optional expiration or rate limits to authenticate Dokploy deployments and infrastructure management.

Instructions

POST /user.createApiKey

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": {
      "name": "<name>",
      "metadata": "<metadata>"
    },
    "name": "user-createApiKey"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
prefixNo
metadataYes
expiresInNo
remainingNo
rateLimitMaxNo
refillAmountNo
refillIntervalNo
rateLimitEnabledNo
rateLimitTimeWindowNo

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 supply only a title and openWorldHint=true, so the description carries the full burden and delivers none of it. For a credential-minting operation it says nothing about permissions required, whether the secret is returned once and unrecoverable, or how rate-limit and expiry parameters affect the resulting key.

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 brief, but brevity here is under-specification rather than economy — a bare route string conveys no information an agent can act on. There is no front-loaded statement of what happens or what is returned.

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?

This is a security-sensitive creation tool with 10 parameters, a nested required object, and no output schema to explain the returned key. A one-line route restatement is wholly inadequate for that complexity, leaving an agent unable to call it correctly or safely.

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?

Schema description coverage is 0% across 10 parameters, including a nested required metadata.organizationId object, yet the description explains none of them. The meanings of expiresIn, remaining, rateLimitMax, refillAmount, refillInterval, rateLimitEnabled, and rateLimitTimeWindow are entirely undocumented.

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 just the HTTP route 'POST /user.createApiKey', which restates the tool name rather than explaining it. Only the name itself signals that an API key is being created; the description adds no verb, resource framing, or scope beyond that tautology.

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?

No when-to-use guidance, no prerequisites, and no mention of the obvious sibling user-deleteApiKey or sshKey-create as alternatives. An agent has no basis for choosing this tool over the key-related siblings.

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