@vibetools/dokploy-mcp 0.5.0 → 1.2.0

package/dist/tools/application.js

@@ -1,16 +1,27 @@
 import { z } from 'zod';
 import { getTool, postTool } from './_factory.js';
 // ── tools ────────────────────────────────────────────────────────────
+const appNameSchema = z
+    .string()
+    .min(1)
+    .max(63)
+    .regex(/^[a-zA-Z0-9._-]+$/)
+    .describe('Internal app name');
+const nullableString = z.string().nullable().optional();
+const nullableBoolean = z.boolean().nullable().optional();
+const nullableNumber = z.number().nullable().optional();
+const nullableStringArray = z.array(z.string()).nullable().optional();
+const nullableUnknown = z.unknown().nullable().optional();
 const create = postTool({
     name: 'dokploy_application_create',
     title: 'Create Application',
-    description: 'Create a new application within a Dokploy project. Requires a project ID and application name. Optionally specify a custom app name, description, and target server for deployment. Returns the created application object with its generated ID.',
+    description: 'Create a new application within a Dokploy environment. Requires an environment ID and application name. Optionally specify a custom app name, description, and target server for deployment. Returns the created application object with its generated ID.',
     schema: z
         .object({
         name: z.string().min(1).describe('The name of the application'),
-        projectId: z.string().min(1).describe('The project ID to create the application in'),
-        appName: z.string().optional().describe('Custom app name (auto-generated if not provided)'),
-        description: z.string().nullable().optional().describe('Application description'),
+        environmentId: z.string().min(1).describe('The environment ID to create the application in'),
+        appName: appNameSchema.optional(),
+        description: nullableString.describe('Application description'),
         serverId: z.string().nullable().optional().describe('Target server ID for deployment'),
     })
         .strict(),
@@ -35,75 +46,132 @@ const update = postTool({
         .object({
         applicationId: z.string().min(1).describe('The unique application ID'),
         name: z.string().optional().describe('Application name'),
-        appName: z.string().optional().describe('Internal app name'),
-        description: z.string().nullable().optional().describe('Application description'),
-        env: z.string().nullable().optional().describe('Environment variables'),
-        buildArgs: z.string().nullable().optional().describe('Docker build arguments'),
-        memoryReservation: z.number().nullable().optional().describe('Memory reservation in bytes'),
-        memoryLimit: z.number().nullable().optional().describe('Memory limit in bytes'),
-        cpuReservation: z.number().nullable().optional().describe('CPU reservation'),
-        cpuLimit: z.number().nullable().optional().describe('CPU limit'),
-        title: z.string().nullable().optional().describe('Display title'),
-        enabled: z.boolean().optional().describe('Whether the application is enabled'),
-        subtitle: z.string().nullable().optional().describe('Display subtitle'),
-        command: z.string().nullable().optional().describe('Custom start command'),
-        publishDirectory: z
-            .string()
-            .nullable()
+        appName: appNameSchema.optional(),
+        description: nullableString.describe('Application description'),
+        env: nullableString.describe('Environment variables'),
+        previewEnv: nullableString.describe('Preview environment variables'),
+        watchPaths: nullableStringArray.describe('Paths to watch for deploy triggers'),
+        previewBuildArgs: nullableString.describe('Preview build arguments'),
+        previewBuildSecrets: nullableString.describe('Preview build secrets'),
+        previewLabels: nullableStringArray.describe('Preview labels'),
+        previewWildcard: nullableString.describe('Preview wildcard'),
+        previewPort: nullableNumber.describe('Preview port'),
+        previewHttps: z.boolean().optional().describe('Whether preview HTTPS is enabled'),
+        previewPath: nullableString.describe('Preview path'),
+        previewCertificateType: z
+            .enum(['letsencrypt', 'none', 'custom'])
             .optional()
-            .describe('Publish directory for static builds'),
-        dockerfile: z.string().nullable().optional().describe('Dockerfile path or content'),
-        dockerContextPath: z.string().optional().describe('Docker build context path'),
-        dockerBuildStage: z.string().optional().describe('Docker multi-stage build target'),
-        replicas: z.number().optional().describe('Number of replicas to run'),
-        applicationStatus: z.string().optional().describe('Application status'),
-        buildType: z.string().optional().describe('Build type'),
-        autoDeploy: z.boolean().optional().describe('Whether auto-deploy is enabled'),
-        createdAt: z.string().optional().describe('Creation timestamp'),
-        registryId: z.string().nullable().optional().describe('Docker registry ID'),
-        projectId: z.string().optional().describe('Project ID'),
-        sourceType: z.string().optional().describe('Source type (github, docker, git, etc.)'),
-        healthCheckSwarm: z
-            .record(z.string(), z.any())
-            .nullable()
+            .describe('Preview certificate type'),
+        previewCustomCertResolver: nullableString.describe('Preview custom certificate resolver'),
+        previewLimit: nullableNumber.describe('Preview deployment limit'),
+        isPreviewDeploymentsActive: nullableBoolean.describe('Whether preview deployments are active'),
+        previewRequireCollaboratorPermissions: nullableBoolean.describe('Whether preview deployments require collaborator permissions'),
+        rollbackActive: nullableBoolean.describe('Whether rollback is active'),
+        buildArgs: nullableString.describe('Docker build arguments'),
+        buildSecrets: nullableString.describe('Docker build secrets'),
+        memoryReservation: nullableString.describe('Memory reservation in bytes (e.g. "268435456" for 256MB)'),
+        memoryLimit: nullableString.describe('Memory limit in bytes (e.g. "268435456" for 256MB)'),
+        cpuReservation: nullableString.describe('CPU reservation in nanoCPUs (e.g. "500000000" for 0.5 CPU)'),
+        cpuLimit: nullableString.describe('CPU limit in nanoCPUs (e.g. "1000000000" for 1 CPU)'),
+        title: nullableString.describe('Display title'),
+        enabled: nullableBoolean.describe('Whether the application is enabled'),
+        subtitle: nullableString.describe('Display subtitle'),
+        command: nullableString.describe('Custom start command'),
+        args: nullableStringArray.describe('Custom command arguments'),
+        refreshToken: nullableString.describe('Webhook token'),
+        sourceType: z
+            .enum(['github', 'docker', 'git', 'gitlab', 'bitbucket', 'gitea', 'drop'])
             .optional()
-            .describe('Swarm health check configuration'),
-        restartPolicySwarm: z
-            .record(z.string(), z.any())
-            .nullable()
-            .optional()
-            .describe('Swarm restart policy configuration'),
-        placementSwarm: z
-            .record(z.string(), z.any())
-            .nullable()
-            .optional()
-            .describe('Swarm placement configuration'),
-        updateConfigSwarm: z
-            .record(z.string(), z.any())
-            .nullable()
-            .optional()
-            .describe('Swarm update configuration'),
-        rollbackConfigSwarm: z
-            .record(z.string(), z.any())
+            .describe('Source type'),
+        cleanCache: nullableBoolean.describe('Whether to clean cache on build'),
+        repository: nullableString.describe('Repository name'),
+        owner: nullableString.describe('Repository owner'),
+        branch: nullableString.describe('Repository branch'),
+        buildPath: nullableString.describe('Build path'),
+        triggerType: z
+            .enum(['push', 'tag'])
             .nullable()
             .optional()
-            .describe('Swarm rollback configuration'),
-        modeSwarm: z
-            .record(z.string(), z.any())
+            .describe('Deployment trigger type'),
+        autoDeploy: nullableBoolean.describe('Whether auto-deploy is enabled'),
+        gitlabProjectId: nullableNumber.describe('GitLab project ID'),
+        gitlabRepository: nullableString.describe('GitLab repository'),
+        gitlabOwner: nullableString.describe('GitLab owner'),
+        gitlabBranch: nullableString.describe('GitLab branch'),
+        gitlabBuildPath: nullableString.describe('GitLab build path'),
+        gitlabPathNamespace: nullableString.describe('GitLab path namespace'),
+        giteaRepository: nullableString.describe('Gitea repository'),
+        giteaOwner: nullableString.describe('Gitea owner'),
+        giteaBranch: nullableString.describe('Gitea branch'),
+        giteaBuildPath: nullableString.describe('Gitea build path'),
+        bitbucketRepository: nullableString.describe('Bitbucket repository'),
+        bitbucketRepositorySlug: nullableString.describe('Bitbucket repository slug'),
+        bitbucketOwner: nullableString.describe('Bitbucket owner'),
+        bitbucketBranch: nullableString.describe('Bitbucket branch'),
+        bitbucketBuildPath: nullableString.describe('Bitbucket build path'),
+        username: nullableString.describe('Registry username'),
+        password: nullableString.describe('Registry password'),
+        dockerImage: nullableString.describe('Docker image'),
+        registryUrl: nullableString.describe('Docker registry URL'),
+        customGitUrl: nullableString.describe('Custom Git URL'),
+        customGitBranch: nullableString.describe('Custom Git branch'),
+        customGitBuildPath: nullableString.describe('Custom Git build path'),
+        customGitSSHKeyId: nullableString.describe('Custom Git SSH key ID'),
+        enableSubmodules: z.boolean().optional().describe('Whether git submodules are enabled'),
+        dockerfile: nullableString.describe('Dockerfile path or content'),
+        dockerContextPath: nullableString.describe('Docker build context path'),
+        dockerBuildStage: nullableString.describe('Docker multi-stage build target'),
+        dropBuildPath: nullableString.describe('Drop build path'),
+        healthCheckSwarm: nullableUnknown.describe('Swarm health check configuration'),
+        restartPolicySwarm: nullableUnknown.describe('Swarm restart policy configuration'),
+        placementSwarm: nullableUnknown.describe('Swarm placement configuration'),
+        updateConfigSwarm: nullableUnknown.describe('Swarm update configuration'),
+        rollbackConfigSwarm: nullableUnknown.describe('Swarm rollback configuration'),
+        modeSwarm: nullableUnknown.describe('Swarm mode configuration'),
+        labelsSwarm: nullableUnknown.describe('Swarm labels configuration'),
+        networkSwarm: nullableUnknown.describe('Swarm network configuration'),
+        stopGracePeriodSwarm: z.number().int().nullable().optional().describe('Stop grace period'),
+        endpointSpecSwarm: nullableUnknown.describe('Swarm endpoint specification'),
+        ulimitsSwarm: z
+            .array(z.object({
+            Name: z.string().min(1).describe('Ulimit name (e.g. "nofile", "nproc", "memlock")'),
+            Soft: z.number().int().min(-1).describe('Soft limit (-1 for unlimited)'),
+            Hard: z.number().int().min(-1).describe('Hard limit (-1 for unlimited)'),
+        }))
             .nullable()
             .optional()
-            .describe('Swarm mode configuration'),
-        labelsSwarm: z
-            .record(z.string(), z.any())
-            .nullable()
+            .describe('Docker Swarm ulimits, e.g. [{"Name":"nofile","Soft":65535,"Hard":65535}]'),
+        replicas: z.number().optional().describe('Number of replicas to run'),
+        applicationStatus: z
+            .enum(['idle', 'running', 'done', 'error'])
             .optional()
-            .describe('Swarm labels configuration'),
-        networkSwarm: z.array(z.any()).nullable().optional().describe('Swarm network configuration'),
-        resourcesSwarm: z
-            .record(z.string(), z.any())
-            .nullable()
+            .describe('Application status'),
+        buildType: z
+            .enum([
+            'dockerfile',
+            'heroku_buildpacks',
+            'paketo_buildpacks',
+            'nixpacks',
+            'static',
+            'railpack',
+        ])
             .optional()
-            .describe('Swarm resources configuration'),
+            .describe('Build type'),
+        railpackVersion: nullableString.describe('Railpack version'),
+        herokuVersion: nullableString.describe('Heroku buildpacks version'),
+        publishDirectory: nullableString.describe('Publish directory for static builds'),
+        isStaticSpa: nullableBoolean.describe('Whether the application is a static SPA'),
+        createEnvFile: z.boolean().optional().describe('Whether to create an env file'),
+        createdAt: z.string().optional().describe('Creation timestamp'),
+        registryId: nullableString.describe('Docker registry ID'),
+        rollbackRegistryId: nullableString.describe('Rollback registry ID'),
+        environmentId: z.string().optional().describe('Environment ID'),
+        githubId: nullableString.describe('GitHub provider ID'),
+        gitlabId: nullableString.describe('GitLab provider ID'),
+        giteaId: nullableString.describe('Gitea provider ID'),
+        bitbucketId: nullableString.describe('Bitbucket provider ID'),
+        buildServerId: nullableString.describe('Build server ID'),
+        buildRegistryId: nullableString.describe('Build registry ID'),
     })
         .strict(),
     endpoint: '/application.update',
@@ -123,11 +191,11 @@ const deleteApp = postTool({
 const move = postTool({
     name: 'dokploy_application_move',
     title: 'Move Application',
-    description: 'Move an application from its current project to a different Dokploy project. Requires both the application ID and the target project ID. The application retains all its configuration and deployment settings after the move.',
+    description: 'Move an application from its current environment to a different Dokploy environment. Requires both the application ID and the target environment ID. The application retains all its configuration and deployment settings after the move.',
     schema: z
         .object({
         applicationId: z.string().min(1).describe('The unique application ID to move'),
-        targetProjectId: z.string().min(1).describe('The target project ID'),
+        targetEnvironmentId: z.string().min(1).describe('The target environment ID'),
     })
         .strict(),
     endpoint: '/application.move',
@@ -139,6 +207,8 @@ const deploy = postTool({
     schema: z
         .object({
         applicationId: z.string().min(1).describe('The unique application ID to deploy'),
+        title: z.string().optional().describe('Optional deployment title'),
+        description: z.string().optional().describe('Optional deployment description'),
     })
         .strict(),
     endpoint: '/application.deploy',
@@ -150,6 +220,8 @@ const redeploy = postTool({
     schema: z
         .object({
         applicationId: z.string().min(1).describe('The unique application ID to redeploy'),
+        title: z.string().optional().describe('Optional deployment title'),
+        description: z.string().optional().describe('Optional deployment description'),
     })
         .strict(),
     endpoint: '/application.redeploy',
@@ -237,15 +309,27 @@ const refreshToken = postTool({
 const saveBuildType = postTool({
     name: 'dokploy_application_save_build_type',
     title: 'Save Build Type',
-    description: 'Set the build type and related build settings for an application in Dokploy. Requires the application ID and a build type (dockerfile, heroku, nixpacks, buildpacks, or docker). Optionally configure the Docker build context path and multi-stage build target stage.',
+    description: 'Set the build type and related build settings for an application in Dokploy. Requires the application ID and build-type payload fields defined by the Dokploy API.',
     schema: z
         .object({
         applicationId: z.string().min(1).describe('The unique application ID'),
         buildType: z
-            .enum(['dockerfile', 'heroku', 'nixpacks', 'buildpacks', 'docker'])
+            .enum([
+            'dockerfile',
+            'heroku_buildpacks',
+            'paketo_buildpacks',
+            'nixpacks',
+            'static',
+            'railpack',
+        ])
             .describe('The build type to use'),
-        dockerContextPath: z.string().optional().describe('Docker build context path'),
-        dockerBuildStage: z.string().optional().describe('Docker multi-stage build target'),
+        dockerfile: z.string().nullable().describe('Dockerfile path or content'),
+        dockerContextPath: z.string().nullable().describe('Docker build context path'),
+        dockerBuildStage: z.string().nullable().describe('Docker multi-stage build target'),
+        herokuVersion: z.string().nullable().describe('Heroku buildpacks version'),
+        railpackVersion: z.string().nullable().describe('Railpack version'),
+        publishDirectory: z.string().nullable().optional().describe('Publish directory'),
+        isStaticSpa: z.boolean().nullable().optional().describe('Whether the build is a static SPA'),
     })
         .strict(),
     endpoint: '/application.saveBuildType',
@@ -257,8 +341,10 @@ const saveEnvironment = postTool({
     schema: z
         .object({
         applicationId: z.string().min(1).describe('The unique application ID'),
-        env: z.string().nullable().optional().describe('Environment variables'),
-        buildArgs: z.string().nullable().optional().describe('Docker build arguments'),
+        env: z.string().nullable().describe('Environment variables'),
+        buildArgs: z.string().nullable().describe('Docker build arguments'),
+        buildSecrets: z.string().nullable().describe('Docker build secrets'),
+        createEnvFile: z.boolean().describe('Whether to create an env file'),
     })
         .strict(),
     endpoint: '/application.saveEnvironment',
@@ -318,14 +404,16 @@ const saveBitbucketProvider = postTool({
     schema: z
         .object({
         applicationId: z.string().min(1).describe('The unique application ID'),
-        bitbucketBranch: z.string().optional().describe('Bitbucket branch'),
-        bitbucketBuildPath: z.string().optional().describe('Build path within the repo'),
-        bitbucketOwner: z.string().optional().describe('Bitbucket repository owner'),
-        bitbucketRepository: z.string().optional().describe('Bitbucket repository name'),
-        bitbucketId: z.string().optional().describe('Bitbucket integration ID'),
+        bitbucketBranch: z.string().nullable().describe('Bitbucket branch'),
+        bitbucketBuildPath: z.string().nullable().describe('Build path within the repo'),
+        bitbucketOwner: z.string().nullable().describe('Bitbucket repository owner'),
+        bitbucketRepository: z.string().nullable().describe('Bitbucket repository name'),
+        bitbucketRepositorySlug: z.string().nullable().describe('Bitbucket repository slug'),
+        bitbucketId: z.string().nullable().describe('Bitbucket integration ID'),
         enableSubmodules: z.boolean().optional().describe('Whether to initialize git submodules'),
         watchPaths: z
             .array(z.string())
+            .nullable()
             .optional()
             .describe('Paths to watch for auto-deploy triggers'),
     })
@@ -376,13 +464,14 @@ const saveGitProvider = postTool({
 const saveDockerProvider = postTool({
     name: 'dokploy_application_save_docker_provider',
     title: 'Configure Docker Provider',
-    description: 'Configure a Docker image as the source for an application in Dokploy. Requires the application ID and a Docker image name (e.g., nginx:latest). Optionally provide registry credentials (username and password) for pulling from private registries.',
+    description: 'Configure a Docker image as the source for an application in Dokploy. Requires the application ID and the Docker provider payload defined by the Dokploy API.',
     schema: z
         .object({
         applicationId: z.string().min(1).describe('The unique application ID'),
-        dockerImage: z.string().min(1).describe('Docker image name (e.g., nginx:latest)'),
-        username: z.string().optional().describe('Registry username for private images'),
-        password: z.string().optional().describe('Registry password for private images'),
+        dockerImage: z.string().nullable().describe('Docker image name (e.g., nginx:latest)'),
+        username: z.string().nullable().describe('Registry username for private images'),
+        password: z.string().nullable().describe('Registry password for private images'),
+        registryUrl: z.string().nullable().describe('Docker registry URL'),
     })
         .strict(),
     endpoint: '/application.saveDockerProvider',
@@ -433,6 +522,51 @@ const updateTraefikConfig = postTool({
         .strict(),
     endpoint: '/application.updateTraefikConfig',
 });
+const clearDeployments = postTool({
+    name: 'dokploy_application_clear_deployments',
+    title: 'Clear Application Deployments',
+    description: 'Clear deployment history for an application in Dokploy. Requires the application ID.',
+    schema: z
+        .object({
+        applicationId: z.string().min(1).describe('The unique application ID'),
+    })
+        .strict(),
+    endpoint: '/application.clearDeployments',
+    annotations: { destructiveHint: true },
+});
+const killBuild = postTool({
+    name: 'dokploy_application_kill_build',
+    title: 'Kill Application Build',
+    description: 'Stop an in-progress application build in Dokploy. Requires the application ID.',
+    schema: z
+        .object({
+        applicationId: z.string().min(1).describe('The unique application ID'),
+    })
+        .strict(),
+    endpoint: '/application.killBuild',
+    annotations: { destructiveHint: true },
+});
+const search = getTool({
+    name: 'dokploy_application_search',
+    title: 'Search Applications',
+    description: 'Search Dokploy applications by free text or field-specific filters. Supports pagination through limit and offset.',
+    schema: z
+        .object({
+        q: z.string().optional().describe('Free-text query'),
+        name: z.string().optional().describe('Application name'),
+        appName: z.string().optional().describe('Internal app name'),
+        description: z.string().optional().describe('Application description'),
+        repository: z.string().optional().describe('Repository name'),
+        owner: z.string().optional().describe('Repository owner'),
+        dockerImage: z.string().optional().describe('Docker image'),
+        projectId: z.string().optional().describe('Project ID'),
+        environmentId: z.string().optional().describe('Environment ID'),
+        limit: z.number().min(1).max(100).optional().describe('Maximum number of results'),
+        offset: z.number().min(0).optional().describe('Number of results to skip'),
+    })
+        .strict(),
+    endpoint: '/application.search',
+});
 // ── export ───────────────────────────────────────────────────────────
 export const applicationTools = [
     create,
@@ -461,4 +595,7 @@ export const applicationTools = [
     readAppMonitoring,
     readTraefikConfig,
     updateTraefikConfig,
+    clearDeployments,
+    killBuild,
+    search,
 ];

package/dist/tools/backup.js

@@ -90,6 +90,33 @@ const manualBackupMongo = postTool({
     schema: z.object({ backupId }).strict(),
     endpoint: '/backup.manualBackupMongo',
 });
+const manualBackupCompose = postTool({
+    name: 'dokploy_backup_manual_compose',
+    title: 'Manual Compose Backup',
+    description: 'Trigger an immediate manual backup for a compose service backup configuration. Requires the backup ID.',
+    schema: z.object({ backupId }).strict(),
+    endpoint: '/backup.manualBackupCompose',
+});
+const manualBackupWebServer = postTool({
+    name: 'dokploy_backup_manual_web_server',
+    title: 'Manual Web Server Backup',
+    description: 'Trigger an immediate manual backup for the Dokploy web server backup configuration. Requires the backup ID.',
+    schema: z.object({ backupId }).strict(),
+    endpoint: '/backup.manualBackupWebServer',
+});
+const listBackupFiles = getTool({
+    name: 'dokploy_backup_list_backup_files',
+    title: 'List Backup Files',
+    description: 'List backup files available at a destination. Requires the destination ID and a search prefix. Optionally filter by server ID.',
+    schema: z
+        .object({
+        destinationId: z.string().describe('Destination ID'),
+        search: z.string().describe('Search prefix'),
+        serverId: z.string().optional().describe('Optional server ID'),
+    })
+        .strict(),
+    endpoint: '/backup.listBackupFiles',
+});
 // ── export ───────────────────────────────────────────────────────────
 export const backupTools = [
     one,
@@ -100,4 +127,7 @@ export const backupTools = [
     manualBackupMySql,
     manualBackupMariadb,
     manualBackupMongo,
+    manualBackupCompose,
+    manualBackupWebServer,
+    listBackupFiles,
 ];