Skip to main content
Glama
MCP Dokploy Online
by igoruam

user-deleteApiKey

Destructive

Deletes a Dokploy user API key by ID to revoke access and stop further authenticated requests.

Instructions

POST /user.deleteApiKey

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": {
      "apiKeyId": "<apiKeyId>"
    },
    "name": "user-deleteApiKey"
  }
}

Input Schema

NameRequiredDescriptionDefault
apiKeyIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.8/5.0
Behavior2/5

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

Annotations already declare destructiveHint=true and openWorldHint=true, so the safety profile is known and the description does not contradict it. However, the description adds nothing beyond those annotations: it does not say the deletion is irreversible, whether other keys or sessions are affected, whether the call is idempotent, or what happens when apiKeyId is unknown.

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 short through under-specification rather than economy: a bare endpoint path is not front-loaded explanatory content. There is no structure to speak of, just a method and route.

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 destructive mutation with an undocumented parameter and no output schema, the description provides nothing an agent needs to invoke it safely or correctly. There is no statement of effect, return behavior, or error conditions, leaving the definition wholly inadequate for the tool's risk profile.

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% and the single required parameter apiKeyId is documented nowhere. The description does not state what form the ID takes, where an agent obtains it, or how invalid IDs are handled, so it fails to compensate for the coverage 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 endpoint string "POST /user.deleteApiKey", which essentially restates the tool name and adds no plain-language statement of effect (e.g. revoking a key immediately, or how the key is identified). An agent can guess the resource from the name, but the description itself does no work beyond naming the HTTP route.

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?

There is no when-to-use or when-not-to-use guidance, no mention of the sibling user-createApiKey as the inverse operation, and no prerequisites such as needing the key's ID or elevated permissions. The agent must infer all routing and precondition decisions from the name alone.

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