@vibetools/dokploy-mcp 0.5.0 → 1.2.0

package/dist/tools/mongo.js

@@ -1,168 +1,13 @@
 import { z } from 'zod';
-import { getTool, postTool } from './_factory.js';
-// ── helpers ──────────────────────────────────────────────────────────
-const mgId = z.string().min(1).describe('Unique MongoDB database ID');
-const DB = 'mongo';
-// ── tools ────────────────────────────────────────────────────────────
-const one = getTool({
-    name: `dokploy_${DB}_one`,
-    title: 'Get MongoDB Details',
-    description: 'Retrieve the full configuration and status details of a MongoDB database managed by Dokploy. Requires the unique MongoDB database ID. Returns all metadata including name, image, resource limits, environment variables, and current application status.',
-    schema: z.object({ mongoId: mgId }).strict(),
-    endpoint: `${DB}.one`,
-});
-const create = postTool({
-    name: `dokploy_${DB}_create`,
-    title: 'Create MongoDB Database',
-    description: 'Create a new MongoDB database instance inside a Dokploy project. Requires a display name, app-level identifier, user credentials, and the target project ID. Optionally specify a Docker image, description, or remote server. Returns the newly created database record.',
-    schema: z
-        .object({
-        name: z.string().min(1).describe('Display name for the database'),
-        appName: z.string().min(1).describe('Unique app-level identifier'),
+import { createDatabaseTools } from './_database.js';
+export const mongoTools = createDatabaseTools({
+    type: 'mongo',
+    idField: 'mongoId',
+    displayName: 'MongoDB',
+    defaultImage: 'mongo:15',
+    createFields: z.object({
         databaseUser: z.string().min(1).describe('Database user'),
         databasePassword: z.string().min(1).describe('Database password'),
-        projectId: z.string().min(1).describe('Project ID to create the database in'),
-        dockerImage: z.string().optional().describe('Docker image (default: mongo:6)'),
-        description: z.string().nullable().optional().describe('Optional description'),
-        serverId: z.string().nullable().optional().describe('Target server ID (null for local)'),
-    })
-        .strict(),
-    endpoint: `${DB}.create`,
-});
-const update = postTool({
-    name: `dokploy_${DB}_update`,
-    title: 'Update MongoDB Database',
-    description: 'Update the configuration of an existing MongoDB database in Dokploy. Requires the MongoDB database ID and accepts optional fields such as name, Docker image, resource limits (memory and CPU), custom start command, environment variables, and external port. Returns the updated database configuration.',
-    schema: z
-        .object({
-        mongoId: mgId,
-        name: z.string().min(1).optional().describe('Display name'),
-        appName: z.string().min(1).optional().describe('App-level identifier'),
-        description: z.string().nullable().optional().describe('Description'),
-        dockerImage: z.string().optional().describe('Docker image'),
-        memoryReservation: z.number().nullable().optional().describe('Memory reservation in MB'),
-        memoryLimit: z.number().nullable().optional().describe('Memory limit in MB'),
-        cpuReservation: z.number().nullable().optional().describe('CPU reservation'),
-        cpuLimit: z.number().nullable().optional().describe('CPU limit'),
-        command: z.string().nullable().optional().describe('Custom start command'),
-        env: z.string().nullable().optional().describe('Environment variables'),
-        externalPort: z.number().nullable().optional().describe('External port'),
-    })
-        .strict(),
-    endpoint: `${DB}.update`,
-});
-const remove = postTool({
-    name: `dokploy_${DB}_remove`,
-    title: 'Remove MongoDB Database',
-    description: 'Permanently delete a MongoDB database from Dokploy. Requires the MongoDB database ID. This is a destructive operation that removes the container, all associated data, and configuration. Returns the operation status confirming deletion.',
-    schema: z.object({ mongoId: mgId }).strict(),
-    endpoint: `${DB}.remove`,
-    annotations: { destructiveHint: true },
-});
-const move = postTool({
-    name: `dokploy_${DB}_move`,
-    title: 'Move MongoDB Database',
-    description: 'Move a MongoDB database from its current project to a different project within Dokploy. Requires the MongoDB database ID and the destination project ID. The database configuration and data remain intact during the move. Returns the operation status.',
-    schema: z
-        .object({
-        mongoId: mgId,
-        targetProjectId: z.string().min(1).describe('Destination project ID'),
-    })
-        .strict(),
-    endpoint: `${DB}.move`,
-});
-const deploy = postTool({
-    name: `dokploy_${DB}_deploy`,
-    title: 'Deploy MongoDB Database',
-    description: 'Deploy a MongoDB database in Dokploy, pulling the configured Docker image and starting the container. Requires the MongoDB database ID. This triggers a full deployment lifecycle including image pull, container creation, and startup. Returns the deployment operation status.',
-    schema: z.object({ mongoId: mgId }).strict(),
-    endpoint: `${DB}.deploy`,
-});
-const start = postTool({
-    name: `dokploy_${DB}_start`,
-    title: 'Start MongoDB Database',
-    description: 'Start a previously stopped MongoDB database container in Dokploy. Requires the MongoDB database ID. The container will resume with its existing data and configuration. Returns the operation status.',
-    schema: z.object({ mongoId: mgId }).strict(),
-    endpoint: `${DB}.start`,
-});
-const stop = postTool({
-    name: `dokploy_${DB}_stop`,
-    title: 'Stop MongoDB Database',
-    description: 'Stop a currently running MongoDB database container in Dokploy. Requires the MongoDB database ID. The container will be gracefully stopped but its data and configuration are preserved for future restarts. Returns the operation status.',
-    schema: z.object({ mongoId: mgId }).strict(),
-    endpoint: `${DB}.stop`,
-    annotations: { destructiveHint: true },
-});
-const reload = postTool({
-    name: `dokploy_${DB}_reload`,
-    title: 'Reload MongoDB Database',
-    description: 'Reload the MongoDB database container in Dokploy without performing a full rebuild. Requires the MongoDB database ID and the app-level identifier. This restarts the container with its current configuration. Returns the operation status.',
-    schema: z
-        .object({
-        mongoId: mgId,
-        appName: z.string().min(1).describe('App-level identifier'),
-    })
-        .strict(),
-    endpoint: `${DB}.reload`,
-});
-const rebuild = postTool({
-    name: `dokploy_${DB}_rebuild`,
-    title: 'Rebuild MongoDB Database',
-    description: 'Rebuild the MongoDB database container from scratch in Dokploy. Requires the MongoDB database ID. This tears down the existing container and recreates it using the current configuration, which is useful when the container state has become inconsistent. Returns the operation status.',
-    schema: z.object({ mongoId: mgId }).strict(),
-    endpoint: `${DB}.rebuild`,
-});
-const changeStatus = postTool({
-    name: `dokploy_${DB}_change_status`,
-    title: 'Change MongoDB Status',
-    description: 'Manually set the application status of a MongoDB database in Dokploy. Requires the MongoDB database ID and the desired status (idle, running, done, or error). This is typically used for administrative overrides when the reported status does not match reality. Returns the updated status.',
-    schema: z
-        .object({
-        mongoId: mgId,
-        applicationStatus: z
-            .enum(['idle', 'running', 'done', 'error'])
-            .describe('New application status'),
-    })
-        .strict(),
-    endpoint: `${DB}.changeStatus`,
-});
-const saveExternalPort = postTool({
-    name: `dokploy_${DB}_save_external_port`,
-    title: 'Save MongoDB External Port',
-    description: 'Set or clear the external port mapping for a MongoDB database in Dokploy. Requires the MongoDB database ID and the desired external port number, or null to remove the external port mapping. This controls whether the database is accessible from outside the Docker network. Returns the operation status.',
-    schema: z
-        .object({
-        mongoId: mgId,
-        externalPort: z.number().nullable().describe('External port number (null to remove)'),
-    })
-        .strict(),
-    endpoint: `${DB}.saveExternalPort`,
-});
-const saveEnvironment = postTool({
-    name: `dokploy_${DB}_save_environment`,
-    title: 'Save MongoDB Environment',
-    description: 'Overwrite the environment variables for a MongoDB database in Dokploy. Requires the MongoDB database ID and the environment variables as a string. This replaces all existing environment variables with the provided values. Returns the operation status.',
-    schema: z
-        .object({
-        mongoId: mgId,
-        env: z.string().nullable().optional().describe('Environment variables as a string'),
-    })
-        .strict(),
-    endpoint: `${DB}.saveEnvironment`,
+        replicaSets: z.boolean().nullable().optional().describe('Whether replica sets are enabled'),
+    }),
 });
-// ── export ───────────────────────────────────────────────────────────
-export const mongoTools = [
-    one,
-    create,
-    update,
-    remove,
-    move,
-    deploy,
-    start,
-    stop,
-    reload,
-    rebuild,
-    changeStatus,
-    saveExternalPort,
-    saveEnvironment,
-];

package/dist/tools/mounts.js

@@ -13,6 +13,17 @@ const one = getTool({
     schema: z.object({ mountId }).strict(),
     endpoint: '/mounts.one',
 });
+const allNamedByApplicationId = getTool({
+    name: 'dokploy_mount_all_named_by_application_id',
+    title: 'List Named Mounts by Application',
+    description: 'List named mounts attached to a Dokploy application. Requires the application ID.',
+    schema: z
+        .object({
+        applicationId: z.string().min(1).describe('Application ID'),
+    })
+        .strict(),
+    endpoint: '/mounts.allNamedByApplicationId',
+});
 const create = postTool({
     name: 'dokploy_mount_create',
     title: 'Create Mount',
@@ -25,13 +36,13 @@ const create = postTool({
             .min(1)
             .describe('Path inside the container where the mount is attached'),
         serviceId: z.string().min(1).describe('ID of the service to attach the mount to'),
-        hostPath: z.string().optional().describe('Host path for bind mounts'),
-        volumeName: z.string().optional().describe('Volume name for volume mounts'),
-        content: z.string().optional().describe('File content for file mounts'),
+        hostPath: z.string().nullable().optional().describe('Host path for bind mounts'),
+        volumeName: z.string().nullable().optional().describe('Volume name for volume mounts'),
+        content: z.string().nullable().optional().describe('File content for file mounts'),
+        filePath: z.string().nullable().optional().describe('File path for file mounts'),
         serviceType: z
             .enum(['application', 'postgres', 'mysql', 'mariadb', 'mongo', 'redis', 'compose'])
             .optional()
-            .default('application')
             .describe('Type of service the mount belongs to'),
     })
         .strict(),
@@ -45,14 +56,40 @@ const update = postTool({
         .object({
         mountId,
         type: mountTypeEnum.optional().describe('New mount type'),
-        mountPath: z.string().optional().describe('New path inside the container'),
-        hostPath: z.string().optional().describe('New host path for bind mounts'),
-        volumeName: z.string().optional().describe('New volume name for volume mounts'),
-        content: z.string().optional().describe('New file content for file mounts'),
+        mountPath: z.string().min(1).optional().describe('New path inside the container'),
+        hostPath: z.string().nullable().optional().describe('New host path for bind mounts'),
+        volumeName: z.string().nullable().optional().describe('New volume name for volume mounts'),
+        filePath: z.string().nullable().optional().describe('New file path for file mounts'),
+        content: z.string().nullable().optional().describe('New file content for file mounts'),
+        serviceType: z
+            .enum(['application', 'postgres', 'mysql', 'mariadb', 'mongo', 'redis', 'compose'])
+            .optional()
+            .describe('Type of service the mount belongs to'),
+        applicationId: z.string().nullable().optional().describe('Application ID'),
+        postgresId: z.string().nullable().optional().describe('Postgres ID'),
+        mariadbId: z.string().nullable().optional().describe('MariaDB ID'),
+        mongoId: z.string().nullable().optional().describe('MongoDB ID'),
+        mysqlId: z.string().nullable().optional().describe('MySQL ID'),
+        redisId: z.string().nullable().optional().describe('Redis ID'),
+        composeId: z.string().nullable().optional().describe('Compose ID'),
     })
         .strict(),
     endpoint: '/mounts.update',
 });
+const listByServiceId = getTool({
+    name: 'dokploy_mount_list_by_service_id',
+    title: 'List Mounts by Service',
+    description: 'List mounts for a Dokploy service. Requires the service ID and the service type.',
+    schema: z
+        .object({
+        serviceId: z.string().min(1).describe('Service ID'),
+        serviceType: z
+            .enum(['application', 'postgres', 'mysql', 'mariadb', 'mongo', 'redis', 'compose'])
+            .describe('Service type'),
+    })
+        .strict(),
+    endpoint: '/mounts.listByServiceId',
+});
 const remove = postTool({
     name: 'dokploy_mount_remove',
     title: 'Remove Mount',
@@ -62,4 +99,11 @@ const remove = postTool({
     annotations: { destructiveHint: true },
 });
 // ── export ───────────────────────────────────────────────────────────
-export const mountsTools = [one, create, update, remove];
+export const mountsTools = [
+    one,
+    allNamedByApplicationId,
+    create,
+    update,
+    listByServiceId,
+    remove,
+];

package/dist/tools/mysql.d.ts

@@ -1,2 +1 @@
-import { type ToolDefinition } from './_factory.js';
-export declare const mysqlTools: ToolDefinition[];
+export declare const mysqlTools: import("./_factory.js").ToolDefinition[];

package/dist/tools/mysql.js

@@ -1,170 +1,14 @@
 import { z } from 'zod';
-import { getTool, postTool } from './_factory.js';
-// ── helpers ──────────────────────────────────────────────────────────
-const myId = z.string().min(1).describe('Unique MySQL database ID');
-const DB = 'mysql';
-// ── tools ────────────────────────────────────────────────────────────
-const one = getTool({
-    name: `dokploy_${DB}_one`,
-    title: 'Get MySQL Details',
-    description: 'Retrieve detailed information about a specific MySQL database managed by Dokploy. Returns the full configuration including connection settings, resource limits, environment variables, and current status. Requires the unique MySQL database ID.',
-    schema: z.object({ mysqlId: myId }).strict(),
-    endpoint: `${DB}.one`,
-});
-const create = postTool({
-    name: `dokploy_${DB}_create`,
-    title: 'Create MySQL Database',
-    description: 'Create a new MySQL database instance inside a Dokploy project. Requires a display name, app-level identifier, database name, user credentials, root password, and the target project ID. Optionally specify a Docker image, description, or remote server. Returns the newly created database record.',
-    schema: z
-        .object({
-        name: z.string().min(1).describe('Display name for the database'),
-        appName: z.string().min(1).describe('Unique app-level identifier'),
+import { createDatabaseTools } from './_database.js';
+export const mysqlTools = createDatabaseTools({
+    type: 'mysql',
+    idField: 'mysqlId',
+    displayName: 'MySQL',
+    defaultImage: 'mysql:8',
+    createFields: z.object({
         databaseName: z.string().min(1).describe('Name of the database to create'),
         databaseUser: z.string().min(1).describe('Database user'),
         databasePassword: z.string().min(1).describe('Database password'),
-        databaseRootPassword: z.string().min(1).describe('Root password for MySQL'),
-        projectId: z.string().min(1).describe('Project ID to create the database in'),
-        dockerImage: z.string().optional().describe('Docker image (default: mysql:8)'),
-        description: z.string().nullable().optional().describe('Optional description'),
-        serverId: z.string().nullable().optional().describe('Target server ID (null for local)'),
-    })
-        .strict(),
-    endpoint: `${DB}.create`,
-});
-const update = postTool({
-    name: `dokploy_${DB}_update`,
-    title: 'Update MySQL Database',
-    description: 'Update the configuration of an existing MySQL database in Dokploy. Supports modifying the display name, Docker image, resource limits (CPU and memory), custom start command, environment variables, and external port. Requires the MySQL database ID. Only the provided fields are updated.',
-    schema: z
-        .object({
-        mysqlId: myId,
-        name: z.string().min(1).optional().describe('Display name'),
-        appName: z.string().min(1).optional().describe('App-level identifier'),
-        description: z.string().nullable().optional().describe('Description'),
-        dockerImage: z.string().optional().describe('Docker image'),
-        memoryReservation: z.number().nullable().optional().describe('Memory reservation in MB'),
-        memoryLimit: z.number().nullable().optional().describe('Memory limit in MB'),
-        cpuReservation: z.number().nullable().optional().describe('CPU reservation'),
-        cpuLimit: z.number().nullable().optional().describe('CPU limit'),
-        command: z.string().nullable().optional().describe('Custom start command'),
-        env: z.string().nullable().optional().describe('Environment variables'),
-        externalPort: z.number().nullable().optional().describe('External port'),
-    })
-        .strict(),
-    endpoint: `${DB}.update`,
-});
-const remove = postTool({
-    name: `dokploy_${DB}_remove`,
-    title: 'Remove MySQL Database',
-    description: 'Permanently delete a MySQL database from Dokploy. This action removes the database container, its data, and all associated configuration. Requires the MySQL database ID. This operation is destructive and cannot be undone.',
-    schema: z.object({ mysqlId: myId }).strict(),
-    endpoint: `${DB}.remove`,
-    annotations: { destructiveHint: true },
-});
-const move = postTool({
-    name: `dokploy_${DB}_move`,
-    title: 'Move MySQL Database',
-    description: 'Move a MySQL database from its current project to a different project within Dokploy. Requires the MySQL database ID and the destination project ID. The database configuration and data are preserved during the move.',
-    schema: z
-        .object({
-        mysqlId: myId,
-        targetProjectId: z.string().min(1).describe('Destination project ID'),
-    })
-        .strict(),
-    endpoint: `${DB}.move`,
-});
-const deploy = postTool({
-    name: `dokploy_${DB}_deploy`,
-    title: 'Deploy MySQL Database',
-    description: 'Deploy a MySQL database container in Dokploy. Triggers the build and start process for the specified database. Requires the MySQL database ID. Returns the deployment status.',
-    schema: z.object({ mysqlId: myId }).strict(),
-    endpoint: `${DB}.deploy`,
-});
-const start = postTool({
-    name: `dokploy_${DB}_start`,
-    title: 'Start MySQL Database',
-    description: 'Start a previously stopped MySQL database container in Dokploy. The database must already be deployed. Requires the MySQL database ID. Returns the updated status after starting.',
-    schema: z.object({ mysqlId: myId }).strict(),
-    endpoint: `${DB}.start`,
-});
-const stop = postTool({
-    name: `dokploy_${DB}_stop`,
-    title: 'Stop MySQL Database',
-    description: 'Stop a running MySQL database container in Dokploy. The database data is preserved but the container will no longer accept connections. Requires the MySQL database ID. This is a destructive action as it interrupts active connections.',
-    schema: z.object({ mysqlId: myId }).strict(),
-    endpoint: `${DB}.stop`,
-    annotations: { destructiveHint: true },
-});
-const reload = postTool({
-    name: `dokploy_${DB}_reload`,
-    title: 'Reload MySQL Database',
-    description: 'Reload the MySQL database container in Dokploy without a full restart. Applies configuration changes that do not require a rebuild. Requires the MySQL database ID and the app-level identifier. Returns the reload status.',
-    schema: z
-        .object({
-        mysqlId: myId,
-        appName: z.string().min(1).describe('App-level identifier'),
-    })
-        .strict(),
-    endpoint: `${DB}.reload`,
-});
-const rebuild = postTool({
-    name: `dokploy_${DB}_rebuild`,
-    title: 'Rebuild MySQL Database',
-    description: 'Rebuild the MySQL database container from scratch in Dokploy. This tears down the existing container and recreates it with the current configuration. Requires the MySQL database ID. Useful after changing the Docker image or when the container is in a broken state.',
-    schema: z.object({ mysqlId: myId }).strict(),
-    endpoint: `${DB}.rebuild`,
-});
-const changeStatus = postTool({
-    name: `dokploy_${DB}_change_status`,
-    title: 'Change MySQL Status',
-    description: 'Manually set the application status of a MySQL database in Dokploy. Accepts one of: idle, running, done, or error. Requires the MySQL database ID and the new status value. Useful for correcting a stale or incorrect status.',
-    schema: z
-        .object({
-        mysqlId: myId,
-        applicationStatus: z
-            .enum(['idle', 'running', 'done', 'error'])
-            .describe('New application status'),
-    })
-        .strict(),
-    endpoint: `${DB}.changeStatus`,
-});
-const saveExternalPort = postTool({
-    name: `dokploy_${DB}_save_external_port`,
-    title: 'Save MySQL External Port',
-    description: 'Set or clear the external port mapping for a MySQL database in Dokploy. When set, the database is accessible from outside the Docker network on the specified port. Pass null to remove the external port. Requires the MySQL database ID.',
-    schema: z
-        .object({
-        mysqlId: myId,
-        externalPort: z.number().nullable().describe('External port number (null to remove)'),
-    })
-        .strict(),
-    endpoint: `${DB}.saveExternalPort`,
-});
-const saveEnvironment = postTool({
-    name: `dokploy_${DB}_save_environment`,
-    title: 'Save MySQL Environment',
-    description: 'Overwrite the environment variables for a MySQL database in Dokploy. Replaces all existing environment variables with the provided value. Pass the variables as a single string (one per line, KEY=VALUE format). Requires the MySQL database ID.',
-    schema: z
-        .object({
-        mysqlId: myId,
-        env: z.string().nullable().optional().describe('Environment variables as a string'),
-    })
-        .strict(),
-    endpoint: `${DB}.saveEnvironment`,
+        databaseRootPassword: z.string().min(1).optional().describe('Root password for MySQL'),
+    }),
 });
-// ── export ───────────────────────────────────────────────────────────
-export const mysqlTools = [
-    one,
-    create,
-    update,
-    remove,
-    move,
-    deploy,
-    start,
-    stop,
-    reload,
-    rebuild,
-    changeStatus,
-    saveExternalPort,
-    saveEnvironment,
-];

package/dist/tools/notification.d.ts

@@ -0,0 +1,2 @@
+import { type ToolDefinition } from './_factory.js';
+export declare const notificationTools: ToolDefinition[];