@vibetools/dokploy-mcp 1.2.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -168
- package/dist/api/client.d.ts +2 -1
- package/dist/api/client.js +3 -11
- package/dist/cli/index.js +1 -0
- package/dist/codemode/context/execute-context.d.ts +590 -0
- package/dist/codemode/context/execute-context.js +64 -0
- package/dist/codemode/context/search-context.d.ts +13851 -0
- package/dist/codemode/context/search-context.js +42 -0
- package/dist/codemode/gateway/api-gateway.d.ts +12 -0
- package/dist/codemode/gateway/api-gateway.js +160 -0
- package/dist/codemode/gateway/error-format.d.ts +13 -0
- package/dist/codemode/gateway/error-format.js +9 -0
- package/dist/codemode/gateway/request-normalizer.d.ts +3 -0
- package/dist/codemode/gateway/request-normalizer.js +21 -0
- package/dist/codemode/gateway/trace.d.ts +13 -0
- package/dist/codemode/gateway/trace.js +11 -0
- package/dist/codemode/sandbox/host.d.ts +11 -0
- package/dist/codemode/sandbox/host.js +28 -0
- package/dist/codemode/sandbox/limits.d.ts +2 -0
- package/dist/codemode/sandbox/limits.js +20 -0
- package/dist/codemode/sandbox/runner.d.ts +8 -0
- package/dist/codemode/sandbox/runner.js +113 -0
- package/dist/codemode/sandbox/runtime.d.ts +2 -0
- package/dist/codemode/sandbox/runtime.js +3 -0
- package/dist/codemode/sandbox/serialize.d.ts +1 -0
- package/dist/codemode/sandbox/serialize.js +45 -0
- package/dist/codemode/sandbox/subprocess-runner.d.ts +10 -0
- package/dist/codemode/sandbox/subprocess-runner.js +91 -0
- package/dist/codemode/sandbox/types.d.ts +12 -0
- package/dist/codemode/sandbox/types.js +1 -0
- package/dist/codemode/sandbox/worker-entry.d.ts +1 -0
- package/dist/codemode/sandbox/worker-entry.js +70 -0
- package/dist/codemode/server-codemode.d.ts +2 -0
- package/dist/codemode/server-codemode.js +17 -0
- package/dist/codemode/tools/execute.d.ts +583 -0
- package/dist/codemode/tools/execute.js +52 -0
- package/dist/codemode/tools/index.d.ts +2 -0
- package/dist/codemode/tools/index.js +3 -0
- package/dist/codemode/tools/search.d.ts +2 -0
- package/dist/codemode/tools/search.js +62 -0
- package/dist/generated/dokploy-catalog.d.ts +27 -0
- package/dist/generated/dokploy-catalog.js +16 -0
- package/dist/generated/dokploy-schemas.d.ts +17533 -0
- package/dist/generated/dokploy-schemas.js +20639 -0
- package/dist/generated/dokploy-sdk.d.ts +558 -0
- package/dist/generated/dokploy-sdk.js +561 -0
- package/dist/generated/openapi-index.json +10591 -0
- package/dist/{tools/_factory.js → mcp/tool-factory.js} +7 -5
- package/dist/server.d.ts +1 -1
- package/dist/server.js +2 -15
- package/package.json +22 -11
- package/dist/tools/_database.d.ts +0 -12
- package/dist/tools/_database.js +0 -115
- package/dist/tools/admin.d.ts +0 -2
- package/dist/tools/admin.js +0 -61
- package/dist/tools/application.d.ts +0 -2
- package/dist/tools/application.js +0 -601
- package/dist/tools/backup.d.ts +0 -2
- package/dist/tools/backup.js +0 -133
- package/dist/tools/certificates.d.ts +0 -2
- package/dist/tools/certificates.js +0 -54
- package/dist/tools/cluster.d.ts +0 -2
- package/dist/tools/cluster.js +0 -38
- package/dist/tools/compose.d.ts +0 -2
- package/dist/tools/compose.js +0 -451
- package/dist/tools/deployment.d.ts +0 -2
- package/dist/tools/deployment.js +0 -107
- package/dist/tools/destination.d.ts +0 -2
- package/dist/tools/destination.js +0 -78
- package/dist/tools/docker.d.ts +0 -2
- package/dist/tools/docker.js +0 -110
- package/dist/tools/domain.d.ts +0 -2
- package/dist/tools/domain.js +0 -147
- package/dist/tools/environment.d.ts +0 -2
- package/dist/tools/environment.js +0 -104
- package/dist/tools/git-provider.d.ts +0 -2
- package/dist/tools/git-provider.js +0 -22
- package/dist/tools/github.d.ts +0 -2
- package/dist/tools/github.js +0 -66
- package/dist/tools/gitlab.d.ts +0 -2
- package/dist/tools/gitlab.js +0 -98
- package/dist/tools/index.d.ts +0 -2
- package/dist/tools/index.js +0 -72
- package/dist/tools/mariadb.d.ts +0 -1
- package/dist/tools/mariadb.js +0 -14
- package/dist/tools/mongo.d.ts +0 -1
- package/dist/tools/mongo.js +0 -13
- package/dist/tools/mounts.d.ts +0 -2
- package/dist/tools/mounts.js +0 -109
- package/dist/tools/mysql.d.ts +0 -1
- package/dist/tools/mysql.js +0 -14
- package/dist/tools/notification.d.ts +0 -2
- package/dist/tools/notification.js +0 -559
- package/dist/tools/patch.d.ts +0 -2
- package/dist/tools/patch.js +0 -179
- package/dist/tools/port.d.ts +0 -2
- package/dist/tools/port.js +0 -54
- package/dist/tools/postgres.d.ts +0 -1
- package/dist/tools/postgres.js +0 -13
- package/dist/tools/preview-deployment.d.ts +0 -2
- package/dist/tools/preview-deployment.js +0 -50
- package/dist/tools/project.d.ts +0 -2
- package/dist/tools/project.js +0 -125
- package/dist/tools/redirects.d.ts +0 -2
- package/dist/tools/redirects.js +0 -53
- package/dist/tools/redis.d.ts +0 -1
- package/dist/tools/redis.js +0 -11
- package/dist/tools/registry.d.ts +0 -2
- package/dist/tools/registry.js +0 -81
- package/dist/tools/rollback.d.ts +0 -2
- package/dist/tools/rollback.js +0 -28
- package/dist/tools/schedule.d.ts +0 -2
- package/dist/tools/schedule.js +0 -92
- package/dist/tools/security.d.ts +0 -2
- package/dist/tools/security.js +0 -48
- package/dist/tools/server.d.ts +0 -2
- package/dist/tools/server.js +0 -192
- package/dist/tools/settings.d.ts +0 -2
- package/dist/tools/settings.js +0 -509
- package/dist/tools/ssh-key.d.ts +0 -2
- package/dist/tools/ssh-key.js +0 -74
- package/dist/tools/user.d.ts +0 -2
- package/dist/tools/user.js +0 -85
- package/dist/tools/volume-backups.d.ts +0 -2
- package/dist/tools/volume-backups.js +0 -96
- /package/dist/{tools/_factory.d.ts → mcp/tool-factory.d.ts} +0 -0
|
@@ -1,601 +0,0 @@
|
|
|
1
|
-
import { z } from 'zod';
|
|
2
|
-
import { getTool, postTool } from './_factory.js';
|
|
3
|
-
// ── tools ────────────────────────────────────────────────────────────
|
|
4
|
-
const appNameSchema = z
|
|
5
|
-
.string()
|
|
6
|
-
.min(1)
|
|
7
|
-
.max(63)
|
|
8
|
-
.regex(/^[a-zA-Z0-9._-]+$/)
|
|
9
|
-
.describe('Internal app name');
|
|
10
|
-
const nullableString = z.string().nullable().optional();
|
|
11
|
-
const nullableBoolean = z.boolean().nullable().optional();
|
|
12
|
-
const nullableNumber = z.number().nullable().optional();
|
|
13
|
-
const nullableStringArray = z.array(z.string()).nullable().optional();
|
|
14
|
-
const nullableUnknown = z.unknown().nullable().optional();
|
|
15
|
-
const create = postTool({
|
|
16
|
-
name: 'dokploy_application_create',
|
|
17
|
-
title: 'Create Application',
|
|
18
|
-
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.',
|
|
19
|
-
schema: z
|
|
20
|
-
.object({
|
|
21
|
-
name: z.string().min(1).describe('The name of the application'),
|
|
22
|
-
environmentId: z.string().min(1).describe('The environment ID to create the application in'),
|
|
23
|
-
appName: appNameSchema.optional(),
|
|
24
|
-
description: nullableString.describe('Application description'),
|
|
25
|
-
serverId: z.string().nullable().optional().describe('Target server ID for deployment'),
|
|
26
|
-
})
|
|
27
|
-
.strict(),
|
|
28
|
-
endpoint: '/application.create',
|
|
29
|
-
});
|
|
30
|
-
const one = getTool({
|
|
31
|
-
name: 'dokploy_application_one',
|
|
32
|
-
title: 'Get Application Details',
|
|
33
|
-
description: 'Retrieve detailed information about a single Dokploy application by its unique ID. Returns the full application object including its configuration, build settings, source provider, environment variables, resource limits, deployment status, and associated domains.',
|
|
34
|
-
schema: z
|
|
35
|
-
.object({
|
|
36
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
37
|
-
})
|
|
38
|
-
.strict(),
|
|
39
|
-
endpoint: '/application.one',
|
|
40
|
-
});
|
|
41
|
-
const update = postTool({
|
|
42
|
-
name: 'dokploy_application_update',
|
|
43
|
-
title: 'Update Application',
|
|
44
|
-
description: "Update an existing application's configuration in Dokploy. Requires the application ID and accepts a wide range of optional fields including name, environment variables, resource limits (CPU and memory), build settings, Docker Swarm configuration, and deployment options. Only provided fields are modified; omitted fields remain unchanged.",
|
|
45
|
-
schema: z
|
|
46
|
-
.object({
|
|
47
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
48
|
-
name: z.string().optional().describe('Application name'),
|
|
49
|
-
appName: appNameSchema.optional(),
|
|
50
|
-
description: nullableString.describe('Application description'),
|
|
51
|
-
env: nullableString.describe('Environment variables'),
|
|
52
|
-
previewEnv: nullableString.describe('Preview environment variables'),
|
|
53
|
-
watchPaths: nullableStringArray.describe('Paths to watch for deploy triggers'),
|
|
54
|
-
previewBuildArgs: nullableString.describe('Preview build arguments'),
|
|
55
|
-
previewBuildSecrets: nullableString.describe('Preview build secrets'),
|
|
56
|
-
previewLabels: nullableStringArray.describe('Preview labels'),
|
|
57
|
-
previewWildcard: nullableString.describe('Preview wildcard'),
|
|
58
|
-
previewPort: nullableNumber.describe('Preview port'),
|
|
59
|
-
previewHttps: z.boolean().optional().describe('Whether preview HTTPS is enabled'),
|
|
60
|
-
previewPath: nullableString.describe('Preview path'),
|
|
61
|
-
previewCertificateType: z
|
|
62
|
-
.enum(['letsencrypt', 'none', 'custom'])
|
|
63
|
-
.optional()
|
|
64
|
-
.describe('Preview certificate type'),
|
|
65
|
-
previewCustomCertResolver: nullableString.describe('Preview custom certificate resolver'),
|
|
66
|
-
previewLimit: nullableNumber.describe('Preview deployment limit'),
|
|
67
|
-
isPreviewDeploymentsActive: nullableBoolean.describe('Whether preview deployments are active'),
|
|
68
|
-
previewRequireCollaboratorPermissions: nullableBoolean.describe('Whether preview deployments require collaborator permissions'),
|
|
69
|
-
rollbackActive: nullableBoolean.describe('Whether rollback is active'),
|
|
70
|
-
buildArgs: nullableString.describe('Docker build arguments'),
|
|
71
|
-
buildSecrets: nullableString.describe('Docker build secrets'),
|
|
72
|
-
memoryReservation: nullableString.describe('Memory reservation in bytes (e.g. "268435456" for 256MB)'),
|
|
73
|
-
memoryLimit: nullableString.describe('Memory limit in bytes (e.g. "268435456" for 256MB)'),
|
|
74
|
-
cpuReservation: nullableString.describe('CPU reservation in nanoCPUs (e.g. "500000000" for 0.5 CPU)'),
|
|
75
|
-
cpuLimit: nullableString.describe('CPU limit in nanoCPUs (e.g. "1000000000" for 1 CPU)'),
|
|
76
|
-
title: nullableString.describe('Display title'),
|
|
77
|
-
enabled: nullableBoolean.describe('Whether the application is enabled'),
|
|
78
|
-
subtitle: nullableString.describe('Display subtitle'),
|
|
79
|
-
command: nullableString.describe('Custom start command'),
|
|
80
|
-
args: nullableStringArray.describe('Custom command arguments'),
|
|
81
|
-
refreshToken: nullableString.describe('Webhook token'),
|
|
82
|
-
sourceType: z
|
|
83
|
-
.enum(['github', 'docker', 'git', 'gitlab', 'bitbucket', 'gitea', 'drop'])
|
|
84
|
-
.optional()
|
|
85
|
-
.describe('Source type'),
|
|
86
|
-
cleanCache: nullableBoolean.describe('Whether to clean cache on build'),
|
|
87
|
-
repository: nullableString.describe('Repository name'),
|
|
88
|
-
owner: nullableString.describe('Repository owner'),
|
|
89
|
-
branch: nullableString.describe('Repository branch'),
|
|
90
|
-
buildPath: nullableString.describe('Build path'),
|
|
91
|
-
triggerType: z
|
|
92
|
-
.enum(['push', 'tag'])
|
|
93
|
-
.nullable()
|
|
94
|
-
.optional()
|
|
95
|
-
.describe('Deployment trigger type'),
|
|
96
|
-
autoDeploy: nullableBoolean.describe('Whether auto-deploy is enabled'),
|
|
97
|
-
gitlabProjectId: nullableNumber.describe('GitLab project ID'),
|
|
98
|
-
gitlabRepository: nullableString.describe('GitLab repository'),
|
|
99
|
-
gitlabOwner: nullableString.describe('GitLab owner'),
|
|
100
|
-
gitlabBranch: nullableString.describe('GitLab branch'),
|
|
101
|
-
gitlabBuildPath: nullableString.describe('GitLab build path'),
|
|
102
|
-
gitlabPathNamespace: nullableString.describe('GitLab path namespace'),
|
|
103
|
-
giteaRepository: nullableString.describe('Gitea repository'),
|
|
104
|
-
giteaOwner: nullableString.describe('Gitea owner'),
|
|
105
|
-
giteaBranch: nullableString.describe('Gitea branch'),
|
|
106
|
-
giteaBuildPath: nullableString.describe('Gitea build path'),
|
|
107
|
-
bitbucketRepository: nullableString.describe('Bitbucket repository'),
|
|
108
|
-
bitbucketRepositorySlug: nullableString.describe('Bitbucket repository slug'),
|
|
109
|
-
bitbucketOwner: nullableString.describe('Bitbucket owner'),
|
|
110
|
-
bitbucketBranch: nullableString.describe('Bitbucket branch'),
|
|
111
|
-
bitbucketBuildPath: nullableString.describe('Bitbucket build path'),
|
|
112
|
-
username: nullableString.describe('Registry username'),
|
|
113
|
-
password: nullableString.describe('Registry password'),
|
|
114
|
-
dockerImage: nullableString.describe('Docker image'),
|
|
115
|
-
registryUrl: nullableString.describe('Docker registry URL'),
|
|
116
|
-
customGitUrl: nullableString.describe('Custom Git URL'),
|
|
117
|
-
customGitBranch: nullableString.describe('Custom Git branch'),
|
|
118
|
-
customGitBuildPath: nullableString.describe('Custom Git build path'),
|
|
119
|
-
customGitSSHKeyId: nullableString.describe('Custom Git SSH key ID'),
|
|
120
|
-
enableSubmodules: z.boolean().optional().describe('Whether git submodules are enabled'),
|
|
121
|
-
dockerfile: nullableString.describe('Dockerfile path or content'),
|
|
122
|
-
dockerContextPath: nullableString.describe('Docker build context path'),
|
|
123
|
-
dockerBuildStage: nullableString.describe('Docker multi-stage build target'),
|
|
124
|
-
dropBuildPath: nullableString.describe('Drop build path'),
|
|
125
|
-
healthCheckSwarm: nullableUnknown.describe('Swarm health check configuration'),
|
|
126
|
-
restartPolicySwarm: nullableUnknown.describe('Swarm restart policy configuration'),
|
|
127
|
-
placementSwarm: nullableUnknown.describe('Swarm placement configuration'),
|
|
128
|
-
updateConfigSwarm: nullableUnknown.describe('Swarm update configuration'),
|
|
129
|
-
rollbackConfigSwarm: nullableUnknown.describe('Swarm rollback configuration'),
|
|
130
|
-
modeSwarm: nullableUnknown.describe('Swarm mode configuration'),
|
|
131
|
-
labelsSwarm: nullableUnknown.describe('Swarm labels configuration'),
|
|
132
|
-
networkSwarm: nullableUnknown.describe('Swarm network configuration'),
|
|
133
|
-
stopGracePeriodSwarm: z.number().int().nullable().optional().describe('Stop grace period'),
|
|
134
|
-
endpointSpecSwarm: nullableUnknown.describe('Swarm endpoint specification'),
|
|
135
|
-
ulimitsSwarm: z
|
|
136
|
-
.array(z.object({
|
|
137
|
-
Name: z.string().min(1).describe('Ulimit name (e.g. "nofile", "nproc", "memlock")'),
|
|
138
|
-
Soft: z.number().int().min(-1).describe('Soft limit (-1 for unlimited)'),
|
|
139
|
-
Hard: z.number().int().min(-1).describe('Hard limit (-1 for unlimited)'),
|
|
140
|
-
}))
|
|
141
|
-
.nullable()
|
|
142
|
-
.optional()
|
|
143
|
-
.describe('Docker Swarm ulimits, e.g. [{"Name":"nofile","Soft":65535,"Hard":65535}]'),
|
|
144
|
-
replicas: z.number().optional().describe('Number of replicas to run'),
|
|
145
|
-
applicationStatus: z
|
|
146
|
-
.enum(['idle', 'running', 'done', 'error'])
|
|
147
|
-
.optional()
|
|
148
|
-
.describe('Application status'),
|
|
149
|
-
buildType: z
|
|
150
|
-
.enum([
|
|
151
|
-
'dockerfile',
|
|
152
|
-
'heroku_buildpacks',
|
|
153
|
-
'paketo_buildpacks',
|
|
154
|
-
'nixpacks',
|
|
155
|
-
'static',
|
|
156
|
-
'railpack',
|
|
157
|
-
])
|
|
158
|
-
.optional()
|
|
159
|
-
.describe('Build type'),
|
|
160
|
-
railpackVersion: nullableString.describe('Railpack version'),
|
|
161
|
-
herokuVersion: nullableString.describe('Heroku buildpacks version'),
|
|
162
|
-
publishDirectory: nullableString.describe('Publish directory for static builds'),
|
|
163
|
-
isStaticSpa: nullableBoolean.describe('Whether the application is a static SPA'),
|
|
164
|
-
createEnvFile: z.boolean().optional().describe('Whether to create an env file'),
|
|
165
|
-
createdAt: z.string().optional().describe('Creation timestamp'),
|
|
166
|
-
registryId: nullableString.describe('Docker registry ID'),
|
|
167
|
-
rollbackRegistryId: nullableString.describe('Rollback registry ID'),
|
|
168
|
-
environmentId: z.string().optional().describe('Environment ID'),
|
|
169
|
-
githubId: nullableString.describe('GitHub provider ID'),
|
|
170
|
-
gitlabId: nullableString.describe('GitLab provider ID'),
|
|
171
|
-
giteaId: nullableString.describe('Gitea provider ID'),
|
|
172
|
-
bitbucketId: nullableString.describe('Bitbucket provider ID'),
|
|
173
|
-
buildServerId: nullableString.describe('Build server ID'),
|
|
174
|
-
buildRegistryId: nullableString.describe('Build registry ID'),
|
|
175
|
-
})
|
|
176
|
-
.strict(),
|
|
177
|
-
endpoint: '/application.update',
|
|
178
|
-
});
|
|
179
|
-
const deleteApp = postTool({
|
|
180
|
-
name: 'dokploy_application_delete',
|
|
181
|
-
title: 'Delete Application',
|
|
182
|
-
description: 'Permanently delete an application from Dokploy. This action is irreversible and will remove all associated data including deployments, logs, environment variables, and domain configurations. Requires the application ID.',
|
|
183
|
-
schema: z
|
|
184
|
-
.object({
|
|
185
|
-
applicationId: z.string().min(1).describe('The unique application ID to delete'),
|
|
186
|
-
})
|
|
187
|
-
.strict(),
|
|
188
|
-
endpoint: '/application.delete',
|
|
189
|
-
annotations: { destructiveHint: true },
|
|
190
|
-
});
|
|
191
|
-
const move = postTool({
|
|
192
|
-
name: 'dokploy_application_move',
|
|
193
|
-
title: 'Move Application',
|
|
194
|
-
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.',
|
|
195
|
-
schema: z
|
|
196
|
-
.object({
|
|
197
|
-
applicationId: z.string().min(1).describe('The unique application ID to move'),
|
|
198
|
-
targetEnvironmentId: z.string().min(1).describe('The target environment ID'),
|
|
199
|
-
})
|
|
200
|
-
.strict(),
|
|
201
|
-
endpoint: '/application.move',
|
|
202
|
-
});
|
|
203
|
-
const deploy = postTool({
|
|
204
|
-
name: 'dokploy_application_deploy',
|
|
205
|
-
title: 'Deploy Application',
|
|
206
|
-
description: 'Trigger a new deployment for an application in Dokploy. Builds the application from its configured source (GitHub, Docker image, Git, etc.) and deploys it to the target server. Requires the application ID. Returns deployment status information.',
|
|
207
|
-
schema: z
|
|
208
|
-
.object({
|
|
209
|
-
applicationId: z.string().min(1).describe('The unique application ID to deploy'),
|
|
210
|
-
title: z.string().optional().describe('Optional deployment title'),
|
|
211
|
-
description: z.string().optional().describe('Optional deployment description'),
|
|
212
|
-
})
|
|
213
|
-
.strict(),
|
|
214
|
-
endpoint: '/application.deploy',
|
|
215
|
-
});
|
|
216
|
-
const redeploy = postTool({
|
|
217
|
-
name: 'dokploy_application_redeploy',
|
|
218
|
-
title: 'Redeploy Application',
|
|
219
|
-
description: 'Force a full redeploy of an application in Dokploy, rebuilding it from source and restarting all containers. Unlike a regular deploy, this always triggers a fresh build regardless of whether the source has changed. Requires the application ID.',
|
|
220
|
-
schema: z
|
|
221
|
-
.object({
|
|
222
|
-
applicationId: z.string().min(1).describe('The unique application ID to redeploy'),
|
|
223
|
-
title: z.string().optional().describe('Optional deployment title'),
|
|
224
|
-
description: z.string().optional().describe('Optional deployment description'),
|
|
225
|
-
})
|
|
226
|
-
.strict(),
|
|
227
|
-
endpoint: '/application.redeploy',
|
|
228
|
-
});
|
|
229
|
-
const start = postTool({
|
|
230
|
-
name: 'dokploy_application_start',
|
|
231
|
-
title: 'Start Application',
|
|
232
|
-
description: 'Start a previously stopped application in Dokploy. Brings up the application containers using the last successful deployment configuration. Requires the application ID. The application must have been deployed at least once before it can be started.',
|
|
233
|
-
schema: z
|
|
234
|
-
.object({
|
|
235
|
-
applicationId: z.string().min(1).describe('The unique application ID to start'),
|
|
236
|
-
})
|
|
237
|
-
.strict(),
|
|
238
|
-
endpoint: '/application.start',
|
|
239
|
-
});
|
|
240
|
-
const stop = postTool({
|
|
241
|
-
name: 'dokploy_application_stop',
|
|
242
|
-
title: 'Stop Application',
|
|
243
|
-
description: 'Stop a running application in Dokploy, shutting down all its containers. The application configuration and data are preserved and it can be restarted later. Requires the application ID. This is a destructive action as it causes downtime.',
|
|
244
|
-
schema: z
|
|
245
|
-
.object({
|
|
246
|
-
applicationId: z.string().min(1).describe('The unique application ID to stop'),
|
|
247
|
-
})
|
|
248
|
-
.strict(),
|
|
249
|
-
endpoint: '/application.stop',
|
|
250
|
-
annotations: { destructiveHint: true },
|
|
251
|
-
});
|
|
252
|
-
const cancelDeployment = postTool({
|
|
253
|
-
name: 'dokploy_application_cancel_deployment',
|
|
254
|
-
title: 'Cancel Deployment',
|
|
255
|
-
description: 'Cancel an in-progress deployment for an application in Dokploy. Stops the current build or deployment process and leaves the application in its previous state. Requires the application ID. Useful when a deployment is stuck or was triggered accidentally.',
|
|
256
|
-
schema: z
|
|
257
|
-
.object({
|
|
258
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
259
|
-
})
|
|
260
|
-
.strict(),
|
|
261
|
-
endpoint: '/application.cancelDeployment',
|
|
262
|
-
});
|
|
263
|
-
const reload = postTool({
|
|
264
|
-
name: 'dokploy_application_reload',
|
|
265
|
-
title: 'Reload Application',
|
|
266
|
-
description: 'Reload an application in Dokploy without performing a full redeploy. Restarts the application containers using the existing built image, which is faster than a complete rebuild. Requires both the application ID and the app name.',
|
|
267
|
-
schema: z
|
|
268
|
-
.object({
|
|
269
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
270
|
-
appName: z.string().min(1).describe('The app name to reload'),
|
|
271
|
-
})
|
|
272
|
-
.strict(),
|
|
273
|
-
endpoint: '/application.reload',
|
|
274
|
-
});
|
|
275
|
-
const markRunning = postTool({
|
|
276
|
-
name: 'dokploy_application_mark_running',
|
|
277
|
-
title: 'Mark Application Running',
|
|
278
|
-
description: 'Manually mark an application as running in Dokploy. This is an administrative action used to correct the application status when it becomes out of sync with the actual container state. Requires the application ID.',
|
|
279
|
-
schema: z
|
|
280
|
-
.object({
|
|
281
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
282
|
-
})
|
|
283
|
-
.strict(),
|
|
284
|
-
endpoint: '/application.markRunning',
|
|
285
|
-
});
|
|
286
|
-
const cleanQueues = postTool({
|
|
287
|
-
name: 'dokploy_application_clean_queues',
|
|
288
|
-
title: 'Clean Deployment Queues',
|
|
289
|
-
description: 'Clean the deployment queues for an application in Dokploy. Removes any pending or stuck deployment jobs from the queue. Requires the application ID. Useful when deployments are queued but not processing correctly.',
|
|
290
|
-
schema: z
|
|
291
|
-
.object({
|
|
292
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
293
|
-
})
|
|
294
|
-
.strict(),
|
|
295
|
-
endpoint: '/application.cleanQueues',
|
|
296
|
-
annotations: { destructiveHint: true },
|
|
297
|
-
});
|
|
298
|
-
const refreshToken = postTool({
|
|
299
|
-
name: 'dokploy_application_refresh_token',
|
|
300
|
-
title: 'Refresh Webhook Token',
|
|
301
|
-
description: 'Refresh the webhook token for an application in Dokploy. Generates a new unique token used for triggering deployments via webhook URLs. The previous token will be invalidated immediately. Requires the application ID.',
|
|
302
|
-
schema: z
|
|
303
|
-
.object({
|
|
304
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
305
|
-
})
|
|
306
|
-
.strict(),
|
|
307
|
-
endpoint: '/application.refreshToken',
|
|
308
|
-
});
|
|
309
|
-
const saveBuildType = postTool({
|
|
310
|
-
name: 'dokploy_application_save_build_type',
|
|
311
|
-
title: 'Save Build Type',
|
|
312
|
-
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.',
|
|
313
|
-
schema: z
|
|
314
|
-
.object({
|
|
315
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
316
|
-
buildType: z
|
|
317
|
-
.enum([
|
|
318
|
-
'dockerfile',
|
|
319
|
-
'heroku_buildpacks',
|
|
320
|
-
'paketo_buildpacks',
|
|
321
|
-
'nixpacks',
|
|
322
|
-
'static',
|
|
323
|
-
'railpack',
|
|
324
|
-
])
|
|
325
|
-
.describe('The build type to use'),
|
|
326
|
-
dockerfile: z.string().nullable().describe('Dockerfile path or content'),
|
|
327
|
-
dockerContextPath: z.string().nullable().describe('Docker build context path'),
|
|
328
|
-
dockerBuildStage: z.string().nullable().describe('Docker multi-stage build target'),
|
|
329
|
-
herokuVersion: z.string().nullable().describe('Heroku buildpacks version'),
|
|
330
|
-
railpackVersion: z.string().nullable().describe('Railpack version'),
|
|
331
|
-
publishDirectory: z.string().nullable().optional().describe('Publish directory'),
|
|
332
|
-
isStaticSpa: z.boolean().nullable().optional().describe('Whether the build is a static SPA'),
|
|
333
|
-
})
|
|
334
|
-
.strict(),
|
|
335
|
-
endpoint: '/application.saveBuildType',
|
|
336
|
-
});
|
|
337
|
-
const saveEnvironment = postTool({
|
|
338
|
-
name: 'dokploy_application_save_environment',
|
|
339
|
-
title: 'Save Environment Variables',
|
|
340
|
-
description: 'Save environment variables and Docker build arguments for an application in Dokploy. Requires the application ID. Environment variables are set at runtime while build arguments are available during the Docker build process. Both fields accept newline-separated key=value pairs.',
|
|
341
|
-
schema: z
|
|
342
|
-
.object({
|
|
343
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
344
|
-
env: z.string().nullable().describe('Environment variables'),
|
|
345
|
-
buildArgs: z.string().nullable().describe('Docker build arguments'),
|
|
346
|
-
buildSecrets: z.string().nullable().describe('Docker build secrets'),
|
|
347
|
-
createEnvFile: z.boolean().describe('Whether to create an env file'),
|
|
348
|
-
})
|
|
349
|
-
.strict(),
|
|
350
|
-
endpoint: '/application.saveEnvironment',
|
|
351
|
-
});
|
|
352
|
-
const saveGithubProvider = postTool({
|
|
353
|
-
name: 'dokploy_application_save_github_provider',
|
|
354
|
-
title: 'Configure GitHub Provider',
|
|
355
|
-
description: 'Configure a GitHub repository as the source for an application in Dokploy. Requires the application ID and the GitHub repository owner. Optionally specify the repository name, branch, build path, GitHub App installation ID, submodule support, watch paths for auto-deploy, and trigger type (push or tag).',
|
|
356
|
-
schema: z
|
|
357
|
-
.object({
|
|
358
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
359
|
-
owner: z.string().min(1).describe('GitHub repository owner'),
|
|
360
|
-
repository: z.string().optional().describe('GitHub repository name'),
|
|
361
|
-
branch: z.string().optional().describe('Branch to deploy from'),
|
|
362
|
-
buildPath: z.string().optional().describe('Build path within the repo'),
|
|
363
|
-
githubId: z.number().optional().describe('GitHub App installation ID'),
|
|
364
|
-
enableSubmodules: z.boolean().optional().describe('Whether to initialize git submodules'),
|
|
365
|
-
watchPaths: z
|
|
366
|
-
.array(z.string())
|
|
367
|
-
.optional()
|
|
368
|
-
.describe('Paths to watch for auto-deploy triggers'),
|
|
369
|
-
triggerType: z
|
|
370
|
-
.enum(['push', 'tag'])
|
|
371
|
-
.optional()
|
|
372
|
-
.describe('Event type that triggers deployment'),
|
|
373
|
-
})
|
|
374
|
-
.strict(),
|
|
375
|
-
endpoint: '/application.saveGithubProvider',
|
|
376
|
-
});
|
|
377
|
-
const saveGitlabProvider = postTool({
|
|
378
|
-
name: 'dokploy_application_save_gitlab_provider',
|
|
379
|
-
title: 'Configure GitLab Provider',
|
|
380
|
-
description: 'Configure a GitLab repository as the source for an application in Dokploy. Requires the application ID. Optionally specify the GitLab branch, build path, repository owner and name, integration ID, project ID, path namespace, submodule support, and watch paths for auto-deploy triggers.',
|
|
381
|
-
schema: z
|
|
382
|
-
.object({
|
|
383
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
384
|
-
gitlabBranch: z.string().optional().describe('GitLab branch'),
|
|
385
|
-
gitlabBuildPath: z.string().optional().describe('Build path within the repo'),
|
|
386
|
-
gitlabOwner: z.string().optional().describe('GitLab repository owner'),
|
|
387
|
-
gitlabRepository: z.string().optional().describe('GitLab repository name'),
|
|
388
|
-
gitlabId: z.number().optional().describe('GitLab integration ID'),
|
|
389
|
-
gitlabProjectId: z.number().optional().describe('GitLab project ID'),
|
|
390
|
-
gitlabPathNamespace: z.string().optional().describe('GitLab path namespace'),
|
|
391
|
-
enableSubmodules: z.boolean().optional().describe('Whether to initialize git submodules'),
|
|
392
|
-
watchPaths: z
|
|
393
|
-
.array(z.string())
|
|
394
|
-
.optional()
|
|
395
|
-
.describe('Paths to watch for auto-deploy triggers'),
|
|
396
|
-
})
|
|
397
|
-
.strict(),
|
|
398
|
-
endpoint: '/application.saveGitlabProvider',
|
|
399
|
-
});
|
|
400
|
-
const saveBitbucketProvider = postTool({
|
|
401
|
-
name: 'dokploy_application_save_bitbucket_provider',
|
|
402
|
-
title: 'Configure Bitbucket Provider',
|
|
403
|
-
description: 'Configure a Bitbucket repository as the source for an application in Dokploy. Requires the application ID. Optionally specify the Bitbucket branch, build path, repository owner and name, integration ID, submodule support, and watch paths for auto-deploy triggers.',
|
|
404
|
-
schema: z
|
|
405
|
-
.object({
|
|
406
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
407
|
-
bitbucketBranch: z.string().nullable().describe('Bitbucket branch'),
|
|
408
|
-
bitbucketBuildPath: z.string().nullable().describe('Build path within the repo'),
|
|
409
|
-
bitbucketOwner: z.string().nullable().describe('Bitbucket repository owner'),
|
|
410
|
-
bitbucketRepository: z.string().nullable().describe('Bitbucket repository name'),
|
|
411
|
-
bitbucketRepositorySlug: z.string().nullable().describe('Bitbucket repository slug'),
|
|
412
|
-
bitbucketId: z.string().nullable().describe('Bitbucket integration ID'),
|
|
413
|
-
enableSubmodules: z.boolean().optional().describe('Whether to initialize git submodules'),
|
|
414
|
-
watchPaths: z
|
|
415
|
-
.array(z.string())
|
|
416
|
-
.nullable()
|
|
417
|
-
.optional()
|
|
418
|
-
.describe('Paths to watch for auto-deploy triggers'),
|
|
419
|
-
})
|
|
420
|
-
.strict(),
|
|
421
|
-
endpoint: '/application.saveBitbucketProvider',
|
|
422
|
-
});
|
|
423
|
-
const saveGiteaProvider = postTool({
|
|
424
|
-
name: 'dokploy_application_save_gitea_provider',
|
|
425
|
-
title: 'Configure Gitea Provider',
|
|
426
|
-
description: 'Configure a Gitea repository as the source for an application in Dokploy. Requires the application ID. Optionally specify the Gitea branch, build path, repository owner and name, integration ID, submodule support, and watch paths for auto-deploy triggers.',
|
|
427
|
-
schema: z
|
|
428
|
-
.object({
|
|
429
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
430
|
-
giteaBranch: z.string().optional().describe('Gitea branch'),
|
|
431
|
-
giteaBuildPath: z.string().optional().describe('Build path within the repo'),
|
|
432
|
-
giteaOwner: z.string().optional().describe('Gitea repository owner'),
|
|
433
|
-
giteaRepository: z.string().optional().describe('Gitea repository name'),
|
|
434
|
-
giteaId: z.number().optional().describe('Gitea integration ID'),
|
|
435
|
-
enableSubmodules: z.boolean().optional().describe('Whether to initialize git submodules'),
|
|
436
|
-
watchPaths: z
|
|
437
|
-
.array(z.string())
|
|
438
|
-
.optional()
|
|
439
|
-
.describe('Paths to watch for auto-deploy triggers'),
|
|
440
|
-
})
|
|
441
|
-
.strict(),
|
|
442
|
-
endpoint: '/application.saveGiteaProvider',
|
|
443
|
-
});
|
|
444
|
-
const saveGitProvider = postTool({
|
|
445
|
-
name: 'dokploy_application_save_git_provider',
|
|
446
|
-
title: 'Configure Custom Git Provider',
|
|
447
|
-
description: 'Configure a custom Git repository as the source for an application in Dokploy. Requires the application ID. Optionally specify the Git URL, branch, build path, SSH key ID for authentication, submodule support, and watch paths for auto-deploy triggers. Supports any Git-compatible repository.',
|
|
448
|
-
schema: z
|
|
449
|
-
.object({
|
|
450
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
451
|
-
customGitUrl: z.string().optional().describe('Custom Git repository URL'),
|
|
452
|
-
customGitBranch: z.string().optional().describe('Branch to deploy from'),
|
|
453
|
-
customGitBuildPath: z.string().optional().describe('Build path within the repo'),
|
|
454
|
-
customGitSSHKeyId: z.string().nullable().optional().describe('SSH key ID for authentication'),
|
|
455
|
-
enableSubmodules: z.boolean().optional().describe('Whether to initialize git submodules'),
|
|
456
|
-
watchPaths: z
|
|
457
|
-
.array(z.string())
|
|
458
|
-
.optional()
|
|
459
|
-
.describe('Paths to watch for auto-deploy triggers'),
|
|
460
|
-
})
|
|
461
|
-
.strict(),
|
|
462
|
-
endpoint: '/application.saveGitProvider',
|
|
463
|
-
});
|
|
464
|
-
const saveDockerProvider = postTool({
|
|
465
|
-
name: 'dokploy_application_save_docker_provider',
|
|
466
|
-
title: 'Configure Docker Provider',
|
|
467
|
-
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.',
|
|
468
|
-
schema: z
|
|
469
|
-
.object({
|
|
470
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
471
|
-
dockerImage: z.string().nullable().describe('Docker image name (e.g., nginx:latest)'),
|
|
472
|
-
username: z.string().nullable().describe('Registry username for private images'),
|
|
473
|
-
password: z.string().nullable().describe('Registry password for private images'),
|
|
474
|
-
registryUrl: z.string().nullable().describe('Docker registry URL'),
|
|
475
|
-
})
|
|
476
|
-
.strict(),
|
|
477
|
-
endpoint: '/application.saveDockerProvider',
|
|
478
|
-
});
|
|
479
|
-
const disconnectGitProvider = postTool({
|
|
480
|
-
name: 'dokploy_application_disconnect_git_provider',
|
|
481
|
-
title: 'Disconnect Git Provider',
|
|
482
|
-
description: 'Disconnect the current Git provider from an application in Dokploy. Removes the source repository configuration (GitHub, GitLab, Bitbucket, Gitea, or custom Git) from the application. Requires the application ID. The application will need a new source configured before it can be deployed again.',
|
|
483
|
-
schema: z
|
|
484
|
-
.object({
|
|
485
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
486
|
-
})
|
|
487
|
-
.strict(),
|
|
488
|
-
endpoint: '/application.disconnectGitProvider',
|
|
489
|
-
annotations: { destructiveHint: true },
|
|
490
|
-
});
|
|
491
|
-
const readAppMonitoring = getTool({
|
|
492
|
-
name: 'dokploy_application_read_app_monitoring',
|
|
493
|
-
title: 'Read Application Monitoring',
|
|
494
|
-
description: 'Read monitoring data for an application in Dokploy. Returns resource usage metrics including CPU utilization, memory consumption, network I/O, and disk usage. Requires the app name (not the application ID). Useful for monitoring application health and performance.',
|
|
495
|
-
schema: z
|
|
496
|
-
.object({
|
|
497
|
-
appName: z.string().min(1).describe('The app name to read monitoring for'),
|
|
498
|
-
})
|
|
499
|
-
.strict(),
|
|
500
|
-
endpoint: '/application.readAppMonitoring',
|
|
501
|
-
});
|
|
502
|
-
const readTraefikConfig = getTool({
|
|
503
|
-
name: 'dokploy_application_read_traefik_config',
|
|
504
|
-
title: 'Read Traefik Configuration',
|
|
505
|
-
description: 'Read the Traefik reverse proxy configuration for an application in Dokploy. Returns the current Traefik routing rules, middleware settings, and TLS configuration associated with the application. Requires the application ID.',
|
|
506
|
-
schema: z
|
|
507
|
-
.object({
|
|
508
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
509
|
-
})
|
|
510
|
-
.strict(),
|
|
511
|
-
endpoint: '/application.readTraefikConfig',
|
|
512
|
-
});
|
|
513
|
-
const updateTraefikConfig = postTool({
|
|
514
|
-
name: 'dokploy_application_update_traefik_config',
|
|
515
|
-
title: 'Update Traefik Configuration',
|
|
516
|
-
description: 'Update the Traefik reverse proxy configuration for an application in Dokploy. Requires the application ID and the new Traefik configuration content as a string. Allows customization of routing rules, middleware, TLS settings, and other Traefik-specific options.',
|
|
517
|
-
schema: z
|
|
518
|
-
.object({
|
|
519
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
520
|
-
traefikConfig: z.string().min(1).describe('The new Traefik configuration content'),
|
|
521
|
-
})
|
|
522
|
-
.strict(),
|
|
523
|
-
endpoint: '/application.updateTraefikConfig',
|
|
524
|
-
});
|
|
525
|
-
const clearDeployments = postTool({
|
|
526
|
-
name: 'dokploy_application_clear_deployments',
|
|
527
|
-
title: 'Clear Application Deployments',
|
|
528
|
-
description: 'Clear deployment history for an application in Dokploy. Requires the application ID.',
|
|
529
|
-
schema: z
|
|
530
|
-
.object({
|
|
531
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
532
|
-
})
|
|
533
|
-
.strict(),
|
|
534
|
-
endpoint: '/application.clearDeployments',
|
|
535
|
-
annotations: { destructiveHint: true },
|
|
536
|
-
});
|
|
537
|
-
const killBuild = postTool({
|
|
538
|
-
name: 'dokploy_application_kill_build',
|
|
539
|
-
title: 'Kill Application Build',
|
|
540
|
-
description: 'Stop an in-progress application build in Dokploy. Requires the application ID.',
|
|
541
|
-
schema: z
|
|
542
|
-
.object({
|
|
543
|
-
applicationId: z.string().min(1).describe('The unique application ID'),
|
|
544
|
-
})
|
|
545
|
-
.strict(),
|
|
546
|
-
endpoint: '/application.killBuild',
|
|
547
|
-
annotations: { destructiveHint: true },
|
|
548
|
-
});
|
|
549
|
-
const search = getTool({
|
|
550
|
-
name: 'dokploy_application_search',
|
|
551
|
-
title: 'Search Applications',
|
|
552
|
-
description: 'Search Dokploy applications by free text or field-specific filters. Supports pagination through limit and offset.',
|
|
553
|
-
schema: z
|
|
554
|
-
.object({
|
|
555
|
-
q: z.string().optional().describe('Free-text query'),
|
|
556
|
-
name: z.string().optional().describe('Application name'),
|
|
557
|
-
appName: z.string().optional().describe('Internal app name'),
|
|
558
|
-
description: z.string().optional().describe('Application description'),
|
|
559
|
-
repository: z.string().optional().describe('Repository name'),
|
|
560
|
-
owner: z.string().optional().describe('Repository owner'),
|
|
561
|
-
dockerImage: z.string().optional().describe('Docker image'),
|
|
562
|
-
projectId: z.string().optional().describe('Project ID'),
|
|
563
|
-
environmentId: z.string().optional().describe('Environment ID'),
|
|
564
|
-
limit: z.number().min(1).max(100).optional().describe('Maximum number of results'),
|
|
565
|
-
offset: z.number().min(0).optional().describe('Number of results to skip'),
|
|
566
|
-
})
|
|
567
|
-
.strict(),
|
|
568
|
-
endpoint: '/application.search',
|
|
569
|
-
});
|
|
570
|
-
// ── export ───────────────────────────────────────────────────────────
|
|
571
|
-
export const applicationTools = [
|
|
572
|
-
create,
|
|
573
|
-
one,
|
|
574
|
-
update,
|
|
575
|
-
deleteApp,
|
|
576
|
-
move,
|
|
577
|
-
deploy,
|
|
578
|
-
redeploy,
|
|
579
|
-
start,
|
|
580
|
-
stop,
|
|
581
|
-
cancelDeployment,
|
|
582
|
-
reload,
|
|
583
|
-
markRunning,
|
|
584
|
-
cleanQueues,
|
|
585
|
-
refreshToken,
|
|
586
|
-
saveBuildType,
|
|
587
|
-
saveEnvironment,
|
|
588
|
-
saveGithubProvider,
|
|
589
|
-
saveGitlabProvider,
|
|
590
|
-
saveBitbucketProvider,
|
|
591
|
-
saveGiteaProvider,
|
|
592
|
-
saveGitProvider,
|
|
593
|
-
saveDockerProvider,
|
|
594
|
-
disconnectGitProvider,
|
|
595
|
-
readAppMonitoring,
|
|
596
|
-
readTraefikConfig,
|
|
597
|
-
updateTraefikConfig,
|
|
598
|
-
clearDeployments,
|
|
599
|
-
killBuild,
|
|
600
|
-
search,
|
|
601
|
-
];
|
package/dist/tools/backup.d.ts
DELETED