Skip to main content
Glama
MCP Dokploy Online
by igoruam

settings-updateTraefikFile

Idempotent

Updates the Traefik configuration file on a Dokploy server to modify routing or middleware settings.

Instructions

POST /settings.updateTraefikFile

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": {
      "path": "<path>",
      "traefikConfig": "<traefikConfig>"
    },
    "name": "settings-updateTraefikFile"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
serverIdNo
traefikConfigYes

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 safety profile is partly covered, but the description adds nothing beyond the route string. It does not say whether the file is replaced wholesale or merged, whether a Traefik reload or restart is required afterward, or whether the path is relative and where it resolves.

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 omission rather than efficiency; the single line carries no explanatory content and gives the reader nothing to front-load. There is no structure beyond a raw endpoint path.

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 mutating file-write tool with three undocumented parameters, no output schema, and no stated preconditions or side effects. Relative to that complexity, the definition provides essentially no information an agent needs to invoke 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 three parameters (path, serverId, traefikConfig), and the description supplies no meaning for any of them. An agent cannot tell whether 'path' is relative to a Traefik config root, what serverId selects, or whether traefikConfig is YAML/TOML content.

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 HTTP route 'POST /settings.updateTraefikFile', which restates the tool name rather than explaining what it does. From the name and schema an agent can guess it writes a Traefik config file at a given path, but the definition itself states no verb, resource, or effect.

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 whatsoever. Siblings such as settings-updateTraefikConfig, settings-readTraefikFile, and settings-updateWebServerTraefikConfig exist, and nothing here indicates how this file-level write differs from the structured config update or when to prefer one over the other.

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