Skip to main content
Glama

dokploy_application

Manage applications across their full lifecycle: create, update, deploy, start, stop, delete, set environment variables, read logs, and access monitoring data.

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. 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. Dates show when Glama detected each change.

  1. 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"
      +}
  2. 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"
      +}
  3. Changed1 schema field changedv1.7.4
    • addedInput schema / additionalProperties
      Added value: +false
  4. 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"
      +}
  5. 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 provided, the description carries the full burden and does it well: it reveals that get returns a masked env summary and never values, saveEnvironment is a full replace, setEnvVars is a server-side read-modify-write with masked confirmation, and getEnvValuesUnsafe writes real values into the transcript/logs. It also exposes the first-deploy failure mode and the search-index limitation, which an agent cannot infer from the schema.

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

Conciseness5/5

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

The description is dense but appropriately sized for a 23-action tool, front-loaded with the resource name and using a consistent action: parameter pattern. Trivial grouped actions like start/stop/delete/markRunning/refreshToken/cleanQueues/killBuild/cancelDeployment are collapsed into one clause, and every sentence carries caveats or semantics rather than fluff.

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

Completeness4/5

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

For a tool with no annotations and no output schema, this is remarkably complete: required IDs per action, env-var safety boundaries, log defaults, deploy retry behavior, and search limitations are all present. The remaining gaps are undefined return shapes for most actions and missing prerequisites for some update paths (e.g., sourceType github requiring repository+owner+branch), but the coverage is strong for the size.

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%, so the description compensates by mapping parameters to actions and adding semantics that are not in the schema: env KEY=VALUE full replace, set/unset upsert/remove behavior, traefikConfig omit-to-read, search fields, and log tail/since/search meaning. Still, the update action hand-waves some fields with 'etc.', and many numeric/resource fields remain unspecified in both schema and description.

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 clearly identifies this as the application management dispatcher ('Manage applications') and enumerates every supported action: create, get, update, move, deploy, start/stop/delete, env operations, build type, traefik config, monitoring, logs, and search. It differentiates from sibling tools by noting the search index is narrower than dokploy_project/dokploy_overview and that it should be used to find a known service, not to inventory.

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?

The description gives explicit usage guidance for search, naming dokploy_project/dokploy_overview as better for inventory, and warns that the first deploy on new services may fail and should be retried immediately. It also flags getEnvValuesUnsafe as an unsafe escape hatch. It does not systematically compare against every sibling (e.g., dokploy_compose, dokploy_deployment) for overlapping operations, but the key routing decisions are covered.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/sapientsai/dokploy-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server