Skip to main content
Glama

dokploy_application

Manage Dokploy application lifecycle: create, configure, deploy, start/stop, edit environment variables, read logs, and search services.

Instructions

Manage applications. create: name+environmentId. get: applicationId (returns metadata + masked env summary — never values). update: applicationId+fields (supports sourceType, repository, owner, branch, customGitUrl, customGitBranch, githubId, dockerImage, networkIds, detachDokployNetwork, etc.). move: applicationId+targetEnvironmentId. deploy: applicationId, redeploy? (note: first deploy on new services may fail — retry immediately). start/stop/delete/markRunning/refreshToken/cleanQueues/killBuild/cancelDeployment: applicationId. reload: applicationId+appName. saveEnvironment: applicationId+env (KEY=VALUE pairs, full replace). setEnvVars: applicationId + set? (KEY=VALUE pairs to upsert) + unset? (KEY names to remove) — read-modify-write inside the server; result is a masked confirmation with changed key names only. getEnvKeys: applicationId — returns just the KEY names (no values). getEnvValuesUnsafe: applicationId — UNSAFE escape hatch that returns full KEY=VALUE pairs (use only when you need actual values; output goes to the tool transcript and any retained logs). saveBuildType: applicationId+buildType. traefikConfig: applicationId, traefikConfig? (omit to read). readMonitoring: appName. readLogs: applicationId, tail? (default 100), since? ('all' or duration like '1h'), search? (substring filter). search: any of q|name|appName|description|repository|owner|dockerImage|projectId|environmentId + limit/offset. deployNginxQuickstart: environmentId, serverId? — creates and deploys a "Hello World" nginx demo app on a generated traefik.me domain (Dokploy's onboarding smoke test). Note: the API's search index is narrower than the project tree — it can return fewer results than dokploy_project/dokploy_overview list, so use it to find a known service, not to inventory.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
qNosearch: freeform query across name/appName/description/repository/owner
envNoEnvironment variables as KEY=VALUE pairs, one per line. Example: 'DB_HOST=localhost\nDB_PORT=5432'. Used by saveEnvironment (full replace).
setNosetEnvVars: KEY=VALUE pairs to upsert, one per line. Existing keys retain order; new keys append.
nameNo
tailNoNumber of recent log lines to return (default 100)
limitNosearch: max results (default 20)
ownerNoGitHub org/user
sinceNoTime range: 'all' or a duration like '30m', '1h', '7d'
titleNo
unsetNosetEnvVars: list of KEY names to remove. Unknown keys are silently skipped.
actionYes
branchNoBranch name
offsetNosearch: pagination offset
searchNoFilter log lines by substring (alphanumeric + ' ._-' only)
appNameNo
commandNo
cpuLimitNo
githubIdNoGitHub App provider ID for private repo access
redeployNo
replicasNo
serverIdNo
buildArgsNo
buildTypeNodockerfile | heroku_buildpacks | paketo_buildpacks | nixpacks | static | railpack
projectIdNosearch: filter to a project
autoDeployNo
dockerfileNo
networkIdsNoupdate: Docker network IDs to attach this application to (see dokploy_network list)
repositoryNoGitHub repository name
sourceTypeNoSource type. github → set repository+owner+branch (+githubId for private). git → set customGitUrl+customGitBranch. docker → set dockerImage. The API also supports gitlab/bitbucket/gitea/drop sources, but those need provider-specific fields not yet exposed by this tool.
descriptionNo
dockerImageNo
memoryLimitNo
buildSecretsNo
customGitUrlNoCustom git repository URL (for sourceType: git)
applicationIdNo
createEnvFileNo
environmentIdNo
traefikConfigNoNew config content (omit to read current)
customGitBranchNoBranch for custom git source
dockerBuildStageNo
publishDirectoryNo
deployDescriptionNoDeploy description (maps to API description field)
dockerContextPathNo
targetEnvironmentIdNo
detachDokployNetworkNoupdate: detach from the default dokploy-network, leaving only networkIds

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.10.0
    • changedInput schema / properties / action / enum
      Previous value: -[
      -  "create",
      -  "get",
      -  "update",
      -  "move",
      -  "deploy",
      -  "start",
      -  "stop",
      -  "delete",
      -  "markRunning",
      -  "refreshToken",
      -  "cleanQueues",
      -  "killBuild",
      -  "cancelDeployment",
      -  "reload",
      -  "saveEnvironment",
      -  "setEnvVars",
      -  "getEnvKeys",
      -  "getEnvValuesUnsafe",
      -  "saveBuildType",
      -  "traefikConfig",
      -  "readMonitoring",
      -  "readLogs",
      -  "search"
      -]New value: +[
      +  "create",
      +  "get",
      +  "update",
      +  "move",
      +  "deploy",
      +  "start",
      +  "stop",
      +  "delete",
      +  "markRunning",
      +  "refreshToken",
      +  "cleanQueues",
      +  "killBuild",
      +  "cancelDeployment",
      +  "reload",
      +  "saveEnvironment",
      +  "setEnvVars",
      +  "getEnvKeys",
      +  "getEnvValuesUnsafe",
      +  "saveBuildType",
      +  "traefikConfig",
      +  "readMonitoring",
      +  "readLogs",
      +  "search",
      +  "deployNginxQuickstart"
      +]
  2. Changed2 schema fields changedv1.9.1
    • addedInput schema / properties / detachDokployNetwork
      Added value: +{
      +  "description": "update: detach from the default dokploy-network, leaving only networkIds",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / networkIds
      Added value: +{
      +  "description": "update: Docker network IDs to attach this application to (see dokploy_network list)",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  3. Changed5 schema fields changedv1.8.3
    • changedInput schema / properties / action / enum
      Previous value: -[
      -  "create",
      -  "get",
      -  "update",
      -  "move",
      -  "deploy",
      -  "start",
      -  "stop",
      -  "delete",
      -  "markRunning",
      -  "refreshToken",
      -  "cleanQueues",
      -  "killBuild",
      -  "cancelDeployment",
      -  "reload",
      -  "saveEnvironment",
      -  "setEnvVars",
      -  "getEnvKeys",
      -  "getEnvValuesUnsafe",
      -  "saveBuildType",
      -  "traefikConfig",
      -  "readMonitoring",
      -  "readLogs"
      -]New value: +[
      +  "create",
      +  "get",
      +  "update",
      +  "move",
      +  "deploy",
      +  "start",
      +  "stop",
      +  "delete",
      +  "markRunning",
      +  "refreshToken",
      +  "cleanQueues",
      +  "killBuild",
      +  "cancelDeployment",
      +  "reload",
      +  "saveEnvironment",
      +  "setEnvVars",
      +  "getEnvKeys",
      +  "getEnvValuesUnsafe",
      +  "saveBuildType",
      +  "traefikConfig",
      +  "readMonitoring",
      +  "readLogs",
      +  "search"
      +]
    • addedInput schema / properties / limit
      Added value: +{
      +  "description": "search: max results (default 20)",
      +  "maximum": 100,
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "description": "search: pagination offset",
      +  "maximum": 9007199254740991,
      +  "minimum": 0,
      +  "type": "integer"
      +}
    • addedInput schema / properties / projectId
      Added value: +{
      +  "description": "search: filter to a project",
      +  "type": "string"
      +}
    • addedInput schema / properties / q
      Added value: +{
      +  "description": "search: freeform query across name/appName/description/repository/owner",
      +  "type": "string"
      +}
  4. Changed1 schema field changedv1.7.4
    • addedInput schema / additionalProperties
      Added value: +false
  5. Changed4 schema fields changedv1.7.3
    • changedInput schema / properties / action / enum
      Previous value: -[
      -  "create",
      -  "get",
      -  "update",
      -  "move",
      -  "deploy",
      -  "start",
      -  "stop",
      -  "delete",
      -  "markRunning",
      -  "refreshToken",
      -  "cleanQueues",
      -  "killBuild",
      -  "cancelDeployment",
      -  "reload",
      -  "saveEnvironment",
      -  "saveBuildType",
      -  "traefikConfig",
      -  "readMonitoring",
      -  "readLogs"
      -]New value: +[
      +  "create",
      +  "get",
      +  "update",
      +  "move",
      +  "deploy",
      +  "start",
      +  "stop",
      +  "delete",
      +  "markRunning",
      +  "refreshToken",
      +  "cleanQueues",
      +  "killBuild",
      +  "cancelDeployment",
      +  "reload",
      +  "saveEnvironment",
      +  "setEnvVars",
      +  "getEnvKeys",
      +  "getEnvValuesUnsafe",
      +  "saveBuildType",
      +  "traefikConfig",
      +  "readMonitoring",
      +  "readLogs"
      +]
    • changedInput schema / properties / env / description
      Previous value: -"Environment variables as KEY=VALUE pairs, one per line. Example: 'DB_HOST=localhost\\nDB_PORT=5432'"New value: +"Environment variables as KEY=VALUE pairs, one per line. Example: 'DB_HOST=localhost\\nDB_PORT=5432'. Used by saveEnvironment (full replace)."
    • addedInput schema / properties / set
      Added value: +{
      +  "description": "setEnvVars: KEY=VALUE pairs to upsert, one per line. Existing keys retain order; new keys append.",
      +  "type": "string"
      +}
    • addedInput schema / properties / unset
      Added value: +{
      +  "description": "setEnvVars: list of KEY names to remove. Unknown keys are silently skipped.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  6. First observedv1.7.0

TDQS

A4.6/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and does so well: it discloses that get masks env values, that saveEnvironment is a full replace, that setEnvVars is a server-side read-modify-write returning only changed key names, and that getEnvValuesUnsafe exposes plaintext values into the transcript and retained logs. It also surfaces the first-deploy failure/retry quirk and the narrow search index.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The 'action: params' pattern is consistent and front-loaded after a one-line purpose statement, and given 24 actions and 45 parameters nearly every clause carries information. It is still a single dense paragraph with no visual breaks, which makes scanning for a specific action slower than it needs to be.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool of this complexity with no output schema and sub-50% schema coverage, the description gives an agent enough to invoke each action correctly, including which actions read versus mutate env state and what each returns in summary form. Only peripheral build/resource-limit parameters are left unaddressed, which is acceptable given they belong to the already-enumerated update path.

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 coverage is only 49% across 45 parameters, so the description must compensate, and it does for the action-critical ones — mapping action to required fields and clarifying semantics like 'KEY=VALUE pairs, full replace' versus upsert plus unset. However, a sizeable set of update parameters (command, cpuLimit, memoryLimit, replicas, buildArgs, dockerfile, publishDirectory, autoDeploy, createEnvFile) is named in a bare list without explanation or the schema documenting them.

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 states the resource ('applications') and then enumerates every action with its required parameters, so an agent knows exactly which operation each action value performs. It also names related sibling tools (dokploy_project, dokploy_overview, dokploy_network) in contrasting contexts, distinguishing this tool from adjacent ones.

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

Usage Guidelines4/5

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

Several actions carry explicit when-to-use guidance: getEnvValuesUnsafe is flagged 'use only when you need actual values', search is scoped to finding a known service rather than inventorying, and the deploy note warns of a retry pattern. It doesn't systematically contrast application actions against dokploy_compose or dokploy_database alternatives, so it stops short of full routing guidance.

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