mcp-dokploy-fullapi-proxy 1.0.1

package/skill/SKILL.md

@@ -0,0 +1,76 @@
+---
+name: dokploy-api
+description: >
+  Use this skill when the user asks to manage Dokploy infrastructure: deploy apps,
+  manage compose services, configure domains, databases, servers, notifications,
+  users, git providers, or any Dokploy administration task. Provides complete API
+  reference for all 436 Dokploy tRPC endpoints accessible via the dokploy MCP tool.
+---
+
+# Dokploy MCP Light - API Skill
+
+## Tool
+One single MCP tool: `dokploy(method, params?)`
+- `method`: tRPC path like `project.all`, `application.deploy`
+- `params`: JSON object with parameters (optional for GET endpoints)
+
+## Routing
+Read the matching reference file for the task:
+
+| Task | File | Endpoints |
+|------|------|-----------|
+| Projects & Environments | `project.md` | 12 |
+| Applications (Deploy, Config, Git, Traefik) | `app.md` | 28 |
+| Compose Services | `compose.md` | 27 |
+| Domains & SSL | `domain.md` | 9 |
+| Databases (PG, MySQL, MariaDB, Mongo, Redis) | `database.md` | 65 |
+| Deployments, Preview, Rollback | `deployment.md` | 12 |
+| Docker Container | `docker.md` | 7 |
+| Server, Cluster, Swarm | `server.md` | 23 |
+| Notifications (Slack, Discord, Telegram, Email, ...) | `notification.md` | 38 |
+| Settings, Admin, Stripe | `settings.md` | 73 |
+| User & Organization | `user.md` | 27 |
+| Git Providers (GitHub, GitLab, Bitbucket, Gitea) | `git.md` | 30 |
+| Mounts, Redirects, Security, Ports, Backups, Schedule, Certs, Registry, SSH, Destinations, Patches, Volume Backups, AI | `infra.md` | 85 |
+
+## Examples
+```
+dokploy("project.all")
+dokploy("application.deploy", { applicationId: "abc123" })
+dokploy("compose.update", { composeId: "xyz", composeFile: "..." })
+dokploy("postgres.create", { name: "mydb", environmentId: "..." })
+```
+
+## Notes
+- GET endpoints (*.all, *.one, etc.): no params or query params required
+- POST endpoints (*.create, *.update, *.deploy, etc.): params as JSON body
+- IDs are always strings
+- Environment variables as multiline string: "KEY=val\nKEY2=val2"
+- On errors: read the API error message and correct params
+
+## pick - Response Filter (Token Optimization)
+Optional `pick` parameter filters the API response clientside to specific fields.
+Use this to avoid token waste on large responses like `project.all`.
+
+**Syntax:** `pick: ["field1", "field2"]`
+
+**How it works:** Recursively traverses the entire JSON structure and retains only objects/arrays
+containing the specified field names. Empty objects/arrays are removed.
+
+**Typical use cases:**
+```
+// Extract only MySQL instances from all projects
+dokploy("project.all", {}, pick: ["mysqlId", "name", "appName", "externalPort", "applicationStatus"])
+
+// Only Postgres IDs and names
+dokploy("project.all", {}, pick: ["postgresId", "name"])
+
+// Backups of a MySQL instance - only essential fields
+dokploy("mysql.one", { mysqlId: "..." }, pick: ["backupId", "schedule", "enabled", "database", "deployments"])
+```
+
+**When to use pick:**
+- `project.all` -> ALWAYS use pick when looking for a specific resource type (mysql, postgres, redis, etc.)
+- There is NO `mysql.all`, `postgres.all` etc. — `project.all` with pick is the only way to list DB instances
+- `mysql.one` / `postgres.one` -> when only a sub-section (backups, mounts, etc.) is needed
+- Any endpoint returning large nested objects

package/skill/app.md

@@ -0,0 +1,144 @@
+# Application
+
+> **Note:** There is NO `application.all`. To list applications, use `project.all` with `pick: ["applicationId", "name", "appName", "applicationStatus"]`.
+
+
+### application.create
+```
+dokploy("application.create", { name: "...", environmentId: "...", appName?: "...", description?: "...", serverId?: "..." })
+```
+
+### application.one
+```
+dokploy("application.one", { applicationId: "..." })
+```
+
+### application.reload
+```
+dokploy("application.reload", { appName: "...", applicationId: "..." })
+```
+
+### application.delete
+```
+dokploy("application.delete", { applicationId: "..." })
+```
+
+### application.stop
+```
+dokploy("application.stop", { applicationId: "..." })
+```
+
+### application.start
+```
+dokploy("application.start", { applicationId: "..." })
+```
+
+### application.redeploy
+```
+dokploy("application.redeploy", { applicationId: "...", title?: "...", description?: "..." })
+```
+
+### application.saveEnvironment
+```
+dokploy("application.saveEnvironment", { applicationId: "...", env: "...", buildArgs: "...", buildSecrets: "...", createEnvFile: "..." })
+```
+
+### application.saveBuildType
+```
+dokploy("application.saveBuildType", { applicationId: "...", buildType: "...", dockerfile: "...", dockerContextPath: "...", dockerBuildStage: "...", herokuVersion: "...", railpackVersion: "...", publishDirectory?: "...", isStaticSpa?: "..." })
+```
+
+### application.saveGithubProvider
+```
+dokploy("application.saveGithubProvider", { applicationId: "...", repository: "...", branch: "...", owner: "...", buildPath: "...", githubId: "...", watchPaths: "...", enableSubmodules: "...", triggerType?: "..." })
+```
+
+### application.saveGitlabProvider
+```
+dokploy("application.saveGitlabProvider", { applicationId: "...", gitlabBranch: "...", gitlabBuildPath: "...", gitlabOwner: "...", gitlabRepository: "...", gitlabId: "...", gitlabProjectId: "...", gitlabPathNamespace: "...", watchPaths: "...", enableSubmodules: "..." })
+```
+
+### application.saveBitbucketProvider
+```
+dokploy("application.saveBitbucketProvider", { bitbucketBranch: "...", bitbucketBuildPath: "...", bitbucketOwner: "...", bitbucketRepository: "...", bitbucketRepositorySlug: "...", bitbucketId: "...", applicationId: "...", watchPaths: "...", enableSubmodules: "..." })
+```
+
+### application.saveGiteaProvider
+```
+dokploy("application.saveGiteaProvider", { applicationId: "...", giteaBranch: "...", giteaBuildPath: "...", giteaOwner: "...", giteaRepository: "...", giteaId: "...", watchPaths: "...", enableSubmodules: "..." })
+```
+
+### application.saveDockerProvider
+```
+dokploy("application.saveDockerProvider", { dockerImage: "...", applicationId: "...", username: "...", password: "...", registryUrl: "..." })
+```
+
+### application.saveGitProvider
+```
+dokploy("application.saveGitProvider", { customGitBranch: "...", applicationId: "...", customGitBuildPath: "...", customGitUrl: "...", watchPaths: "...", enableSubmodules: "...", customGitSSHKeyId?: "..." })
+```
+
+### application.disconnectGitProvider
+```
+dokploy("application.disconnectGitProvider", { applicationId: "..." })
+```
+
+### application.markRunning
+```
+dokploy("application.markRunning", { applicationId: "..." })
+```
+
+### application.update
+```
+dokploy("application.update", { applicationId: "...", name?: "...", appName?: "...", description?: "...", env?: "...", previewEnv?: "...", watchPaths?: "...", previewBuildArgs?: "...", previewBuildSecrets?: "...", previewLabels?: "...", previewWildcard?: "...", previewPort?: "...", previewHttps?: "...", previewPath?: "...", previewCertificateType?: "...", previewCustomCertResolver?: "...", previewLimit?: "...", isPreviewDeploymentsActive?: "...", previewRequireCollaboratorPermissions?: "...", rollbackActive?: "...", buildArgs?: "...", buildSecrets?: "...", memoryReservation?: "...", memoryLimit?: "...", cpuReservation?: "...", cpuLimit?: "...", title?: "...", enabled?: "...", subtitle?: "...", command?: "...", args?: "...", refreshToken?: "...", sourceType?: "...", cleanCache?: "...", repository?: "...", owner?: "...", branch?: "...", buildPath?: "...", triggerType?: "...", autoDeploy?: "...", gitlabProjectId?: "...", gitlabRepository?: "...", gitlabOwner?: "...", gitlabBranch?: "...", gitlabBuildPath?: "...", gitlabPathNamespace?: "...", giteaRepository?: "...", giteaOwner?: "...", giteaBranch?: "...", giteaBuildPath?: "...", bitbucketRepository?: "...", bitbucketRepositorySlug?: "...", bitbucketOwner?: "...", bitbucketBranch?: "...", bitbucketBuildPath?: "...", username?: "...", password?: "...", dockerImage?: "...", registryUrl?: "...", customGitUrl?: "...", customGitBranch?: "...", customGitBuildPath?: "...", customGitSSHKeyId?: "...", enableSubmodules?: "...", dockerfile?: "...", dockerContextPath?: "...", dockerBuildStage?: "...", dropBuildPath?: "...", healthCheckSwarm?: "...", restartPolicySwarm?: "...", placementSwarm?: "...", updateConfigSwarm?: "...", rollbackConfigSwarm?: "...", modeSwarm?: "...", labelsSwarm?: "...", networkSwarm?: "...", stopGracePeriodSwarm?: "...", endpointSpecSwarm?: "...", ulimitsSwarm?: "...", replicas?: "...", applicationStatus?: "...", buildType?: "...", railpackVersion?: "...", herokuVersion?: "...", publishDirectory?: "...", isStaticSpa?: "...", createEnvFile?: "...", createdAt?: "...", registryId?: "...", rollbackRegistryId?: "...", environmentId?: "...", githubId?: "...", gitlabId?: "...", giteaId?: "...", bitbucketId?: "...", buildServerId?: "...", buildRegistryId?: "..." })
+```
+
+### application.refreshToken
+```
+dokploy("application.refreshToken", { applicationId: "..." })
+```
+
+### application.deploy
+```
+dokploy("application.deploy", { applicationId: "...", title?: "...", description?: "..." })
+```
+
+### application.cleanQueues
+```
+dokploy("application.cleanQueues", { applicationId: "..." })
+```
+
+### application.clearDeployments
+```
+dokploy("application.clearDeployments", { applicationId: "..." })
+```
+
+### application.killBuild
+```
+dokploy("application.killBuild", { applicationId: "..." })
+```
+
+### application.readTraefikConfig
+```
+dokploy("application.readTraefikConfig", { applicationId: "..." })
+```
+
+### application.updateTraefikConfig
+```
+dokploy("application.updateTraefikConfig", { applicationId: "...", traefikConfig: "..." })
+```
+
+### application.readAppMonitoring
+```
+dokploy("application.readAppMonitoring", { appName: "..." })
+```
+
+### application.move
+```
+dokploy("application.move", { applicationId: "...", targetEnvironmentId: "..." })
+```
+
+### application.cancelDeployment
+```
+dokploy("application.cancelDeployment", { applicationId: "..." })
+```

package/skill/compose.md

@@ -0,0 +1,139 @@
+# Compose
+
+> **Note:** There is NO `compose.all`. To list compose services, use `project.all` with `pick: ["composeId", "name", "appName"]`.
+
+
+### compose.create
+```
+dokploy("compose.create", { name: "...", environmentId: "...", description?: "...", composeType?: "...", appName?: "...", serverId?: "...", composeFile?: "..." })
+```
+
+### compose.one
+```
+dokploy("compose.one", { composeId: "..." })
+```
+
+### compose.update
+```
+dokploy("compose.update", { composeId: "...", name?: "...", appName?: "...", description?: "...", env?: "...", composeFile?: "...", refreshToken?: "...", sourceType?: "...", composeType?: "...", repository?: "...", owner?: "...", branch?: "...", autoDeploy?: "...", gitlabProjectId?: "...", gitlabRepository?: "...", gitlabOwner?: "...", gitlabBranch?: "...", gitlabPathNamespace?: "...", bitbucketRepository?: "...", bitbucketRepositorySlug?: "...", bitbucketOwner?: "...", bitbucketBranch?: "...", giteaRepository?: "...", giteaOwner?: "...", giteaBranch?: "...", customGitUrl?: "...", customGitBranch?: "...", customGitSSHKeyId?: "...", command?: "...", enableSubmodules?: "...", composePath?: "...", suffix?: "...", randomize?: "...", isolatedDeployment?: "...", isolatedDeploymentsVolume?: "...", triggerType?: "...", composeStatus?: "...", environmentId?: "...", createdAt?: "...", watchPaths?: "...", githubId?: "...", gitlabId?: "...", bitbucketId?: "...", giteaId?: "..." })
+```
+
+### compose.delete
+```
+dokploy("compose.delete", { composeId: "...", deleteVolumes: "..." })
+```
+
+### compose.cleanQueues
+```
+dokploy("compose.cleanQueues", { composeId: "..." })
+```
+
+### compose.clearDeployments
+```
+dokploy("compose.clearDeployments", { composeId: "..." })
+```
+
+### compose.killBuild
+```
+dokploy("compose.killBuild", { composeId: "..." })
+```
+
+### compose.loadServices
+```
+dokploy("compose.loadServices", { composeId: "...", type?: "..." })
+```
+
+### compose.loadMountsByService
+```
+dokploy("compose.loadMountsByService", { composeId: "...", serviceName: "..." })
+```
+
+### compose.fetchSourceType
+```
+dokploy("compose.fetchSourceType", { composeId: "..." })
+```
+
+### compose.randomizeCompose
+```
+dokploy("compose.randomizeCompose", { composeId: "...", suffix?: "..." })
+```
+
+### compose.isolatedDeployment
+```
+dokploy("compose.isolatedDeployment", { composeId: "...", suffix?: "..." })
+```
+
+### compose.getConvertedCompose
+```
+dokploy("compose.getConvertedCompose", { composeId: "..." })
+```
+
+### compose.deploy
+```
+dokploy("compose.deploy", { composeId: "...", title?: "...", description?: "..." })
+```
+
+### compose.redeploy
+```
+dokploy("compose.redeploy", { composeId: "...", title?: "...", description?: "..." })
+```
+
+### compose.stop
+```
+dokploy("compose.stop", { composeId: "..." })
+```
+
+### compose.start
+```
+dokploy("compose.start", { composeId: "..." })
+```
+
+### compose.getDefaultCommand
+```
+dokploy("compose.getDefaultCommand", { composeId: "..." })
+```
+
+### compose.refreshToken
+```
+dokploy("compose.refreshToken", { composeId: "..." })
+```
+
+### compose.deployTemplate
+```
+dokploy("compose.deployTemplate", { environmentId: "...", id: "...", serverId?: "...", baseUrl?: "..." })
+```
+
+### compose.templates
+```
+dokploy("compose.templates", { baseUrl?: "..." })
+```
+
+### compose.getTags
+```
+dokploy("compose.getTags", { baseUrl?: "..." })
+```
+
+### compose.disconnectGitProvider
+```
+dokploy("compose.disconnectGitProvider", { composeId: "..." })
+```
+
+### compose.move
+```
+dokploy("compose.move", { composeId: "...", targetEnvironmentId: "..." })
+```
+
+### compose.processTemplate
+```
+dokploy("compose.processTemplate", { base64: "...", composeId: "..." })
+```
+
+### compose.import
+```
+dokploy("compose.import", { base64: "...", composeId: "..." })
+```
+
+### compose.cancelDeployment
+```
+dokploy("compose.cancelDeployment", { composeId: "..." })
+```