Skip to main content
Glama
MCP Dokploy Online
by igoruam

port-update

Idempotent

Updates an existing Dokploy port mapping by setting published and target ports, protocol, and publish mode to control how traffic is exposed.

Instructions

POST /port.update

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": {
      "portId": "<portId>",
      "publishedPort": "<publishedPort>",
      "targetPort": "<targetPort>"
    },
    "name": "port-update"
  }
}

Input Schema

NameRequiredDescriptionDefault
portIdYes
protocolNotcp
targetPortYes
publishModeNoingress
publishedPortYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

D1.6/5.0
Behavior2/5

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

Annotations already declare idempotentHint=true and openWorldHint=true, so the description is not required to carry the safety profile. Still, it adds nothing about what an update does to the existing mapping — whether omitted fields are reset to defaults (both protocol and publishMode have defaults in the schema), whether the change disrupts live traffic, or what permissions are required.

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 is under-specification rather than economy — a bare route string is not a front-loaded explanation of purpose. Nothing about it earns its place beyond the verb.

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 five-parameter mutation with no output schema and zero parameter documentation, the description omits everything an agent needs: parameter meaning, default behavior on update, and effects on existing state. It is not a usable specification.

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% for five parameters, including two enums (protocol tcp/udp, publishMode ingress/host), and the description compensates for none of it. An agent gets no meaning for portId, publishedPort vs targetPort, or how defaults are applied on update.

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?

"POST /port.update" merely restates the tool name and its HTTP verb; it never says what a port is here (a container/service port mapping), what updating it means, or how it differs from sibling port-create/port-delete. The agent learns nothing beyond the name.

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 port-create for new mappings or port-delete for removal. The caller must guess when updating is appropriate versus creating or recreating.

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