@vibetools/dokploy-mcp 0.5.0 → 1.2.0

package/dist/tools/user.js

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { getTool } from './_factory.js';
+import { getTool, postTool } from './_factory.js';
 // ── tools ────────────────────────────────────────────────────────────
 const all = getTool({
     name: 'dokploy_user_all',
@@ -8,5 +8,78 @@ const all = getTool({
     schema: z.object({}).strict(),
     endpoint: '/user.all',
 });
+const session = getTool({
+    name: 'dokploy_user_session',
+    title: 'Get User Session',
+    description: 'Get the current authenticated user session from Dokploy, including session and identity metadata.',
+    schema: z.object({}).strict(),
+    endpoint: '/user.session',
+});
+const get = getTool({
+    name: 'dokploy_user_get',
+    title: 'Get Current User',
+    description: 'Get the current authenticated Dokploy user profile.',
+    schema: z.object({}).strict(),
+    endpoint: '/user.get',
+});
+const getPermissions = getTool({
+    name: 'dokploy_user_get_permissions',
+    title: 'Get Current User Permissions',
+    description: 'Get the current authenticated Dokploy user permissions.',
+    schema: z.object({}).strict(),
+    endpoint: '/user.getPermissions',
+});
+const haveRootAccess = getTool({
+    name: 'dokploy_user_have_root_access',
+    title: 'Check Root Access',
+    description: 'Check whether the current authenticated Dokploy user has root access.',
+    schema: z.object({}).strict(),
+    endpoint: '/user.haveRootAccess',
+});
+const createApiKey = postTool({
+    name: 'dokploy_user_create_api_key',
+    title: 'Create API Key',
+    description: 'Create a new Dokploy API key. Requires a name and organization metadata. Optionally configure expiration and rate limiting.',
+    schema: z
+        .object({
+        name: z.string().min(1).describe('API key name'),
+        prefix: z.string().optional().describe('API key prefix'),
+        expiresIn: z.number().optional().describe('Expiration interval'),
+        metadata: z
+            .object({
+            organizationId: z.string().describe('Organization ID'),
+        })
+            .strict()
+            .describe('API key metadata'),
+        rateLimitEnabled: z.boolean().optional().describe('Whether rate limiting is enabled'),
+        rateLimitTimeWindow: z.number().optional().describe('Rate limit time window'),
+        rateLimitMax: z.number().optional().describe('Rate limit max requests'),
+        remaining: z.number().optional().describe('Remaining requests'),
+        refillAmount: z.number().optional().describe('Rate limit refill amount'),
+        refillInterval: z.number().optional().describe('Rate limit refill interval'),
+    })
+        .strict(),
+    endpoint: '/user.createApiKey',
+});
+const deleteApiKey = postTool({
+    name: 'dokploy_user_delete_api_key',
+    title: 'Delete API Key',
+    description: 'Delete a Dokploy API key by its ID. This is a destructive action.',
+    schema: z
+        .object({
+        apiKeyId: z.string().describe('API key ID'),
+    })
+        .strict(),
+    endpoint: '/user.deleteApiKey',
+    annotations: { destructiveHint: true },
+});
 // ── export ───────────────────────────────────────────────────────────
-export const userTools = [all];
+export const userTools = [
+    all,
+    session,
+    get,
+    getPermissions,
+    haveRootAccess,
+    createApiKey,
+    deleteApiKey,
+];

package/dist/tools/volume-backups.d.ts

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

package/dist/tools/volume-backups.js

@@ -0,0 +1,96 @@
+import { z } from 'zod';
+import { getTool, postTool } from './_factory.js';
+const serviceTypeSchema = z
+    .enum(['application', 'postgres', 'mysql', 'mariadb', 'mongo', 'redis', 'compose'])
+    .describe('Service type');
+const nullableString = z.string().nullable().optional();
+const nullableBoolean = z.boolean().nullable().optional();
+const nullableNumber = z.number().nullable().optional();
+const volumeBackupPayload = z
+    .object({
+    name: z.string().describe('Volume backup name'),
+    volumeName: z.string().describe('Docker volume name'),
+    prefix: z.string().describe('Backup file prefix'),
+    serviceType: serviceTypeSchema.optional(),
+    appName: z.string().optional().describe('App name'),
+    serviceName: nullableString.describe('Compose service name'),
+    turnOff: z.boolean().optional().describe('Whether to turn off the service during backup'),
+    cronExpression: z.string().describe('Cron expression'),
+    keepLatestCount: nullableNumber.describe('Number of backups to keep'),
+    enabled: nullableBoolean.describe('Whether the backup is enabled'),
+    applicationId: nullableString.describe('Application ID'),
+    postgresId: nullableString.describe('Postgres ID'),
+    mariadbId: nullableString.describe('MariaDB ID'),
+    mongoId: nullableString.describe('MongoDB ID'),
+    mysqlId: nullableString.describe('MySQL ID'),
+    redisId: nullableString.describe('Redis ID'),
+    composeId: nullableString.describe('Compose ID'),
+    createdAt: z.string().optional().describe('Creation timestamp'),
+    destinationId: z.string().describe('Destination ID'),
+})
+    .strict();
+const list = getTool({
+    name: 'dokploy_volume_backups_list',
+    title: 'List Volume Backups',
+    description: 'List volume backup configurations for a Dokploy service type. Requires the entity ID and volume backup type.',
+    schema: z
+        .object({
+        id: z.string().min(1).describe('Entity ID'),
+        volumeBackupType: serviceTypeSchema.describe('Volume backup type'),
+    })
+        .strict(),
+    endpoint: '/volumeBackups.list',
+});
+const one = getTool({
+    name: 'dokploy_volume_backups_one',
+    title: 'Get Volume Backup',
+    description: 'Retrieve a volume backup configuration by its ID.',
+    schema: z
+        .object({
+        volumeBackupId: z.string().min(1).describe('Volume backup ID'),
+    })
+        .strict(),
+    endpoint: '/volumeBackups.one',
+});
+const create = postTool({
+    name: 'dokploy_volume_backups_create',
+    title: 'Create Volume Backup',
+    description: 'Create a volume backup configuration in Dokploy. Requires the backup name, volume name, prefix, cron expression, and destination ID.',
+    schema: volumeBackupPayload,
+    endpoint: '/volumeBackups.create',
+});
+const update = postTool({
+    name: 'dokploy_volume_backups_update',
+    title: 'Update Volume Backup',
+    description: 'Update a volume backup configuration in Dokploy. Requires the volume backup ID together with the updated backup payload.',
+    schema: volumeBackupPayload
+        .extend({
+        volumeBackupId: z.string().min(1).describe('Volume backup ID'),
+    })
+        .strict(),
+    endpoint: '/volumeBackups.update',
+});
+const remove = postTool({
+    name: 'dokploy_volume_backups_delete',
+    title: 'Delete Volume Backup',
+    description: 'Delete a volume backup configuration from Dokploy. Requires the volume backup ID. This is a destructive action.',
+    schema: z
+        .object({
+        volumeBackupId: z.string().min(1).describe('Volume backup ID'),
+    })
+        .strict(),
+    endpoint: '/volumeBackups.delete',
+    annotations: { destructiveHint: true },
+});
+const runManually = postTool({
+    name: 'dokploy_volume_backups_run_manually',
+    title: 'Run Volume Backup Manually',
+    description: 'Trigger a volume backup immediately in Dokploy. Requires the volume backup ID.',
+    schema: z
+        .object({
+        volumeBackupId: z.string().min(1).describe('Volume backup ID'),
+    })
+        .strict(),
+    endpoint: '/volumeBackups.runManually',
+});
+export const volumeBackupsTools = [list, one, create, update, remove, runManually];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vibetools/dokploy-mcp",
-  "version": "0.5.0",
+  "version": "1.2.0",
   "description": "MCP Server for the Dokploy API - complete coverage of all endpoints",
   "type": "module",
   "exports": {
@@ -19,6 +19,9 @@
     "build": "tsc",
     "dev": "tsc --watch",
     "start": "node dist/index.js",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
     "typecheck": "tsc --noEmit",
     "lint": "biome check .",
     "lint:fix": "biome check --write .",
@@ -34,7 +37,9 @@
   "devDependencies": {
     "@biomejs/biome": "^2.4.4",
     "@types/node": "^22.19.11",
-    "typescript": "^5.9.3"
+    "@vitest/coverage-v8": "^4.0.18",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   },
   "engines": {
     "node": ">=22.0.0"