@dokploy/mcp 0.29.0 → 0.29.3

package/README.md

@@ -287,10 +287,19 @@ The configuration on Windows is slightly different compared to Linux or macOS. U
 |----------|----------|-------------|
 | `DOKPLOY_URL` | Yes | Your Dokploy server URL (e.g., `https://your-dokploy-server.com`) |
 | `DOKPLOY_API_KEY` | Yes | Your Dokploy API authentication token |
+| `DOKPLOY_CUSTOM_HEADERS` | No | JSON object of additional upstream request headers. Header names and values must be strings. Reserved headers cannot be set here: `x-api-key`, `content-type`, `accept`. |
 | `DOKPLOY_ENABLED_TAGS` | No | Comma-separated list of tags to filter which tools are loaded (e.g., `project,application,postgres`) |
 | `DOKPLOY_TIMEOUT` | No | Request timeout in milliseconds (default: `30000`) |
 | `DOKPLOY_RETRY_ATTEMPTS` | No | Number of retry attempts (default: `3`) |
 | `DOKPLOY_RETRY_DELAY` | No | Delay between retries in milliseconds (default: `1000`) |
+| `DOKPLOY_REDACT_ENV` | No | When `true`, redacts secret-bearing fields from API responses before they reach the MCP client (default: `false`). Useful when an LLM consumes responses and you don't want env vars or compose files in its context. |
+| `DOKPLOY_REDACT_FIELDS` | No | Comma-separated list of response field names to redact when `DOKPLOY_REDACT_ENV=true`. Matched case-insensitively at any nesting depth. Defaults to: `env`, `buildArgs`, `composeFile`, `dockerCompose`, `environment`, `buildSecrets`, `previewBuildSecrets`, `password`, `currentPassword`, `appPassword`, `databasePassword`, `databaseRootPassword`, `redisPassword`, `mariadbPassword`, `mongoPassword`, `mysqlPassword`, `postgresPassword`, `registryPassword`, `token`, `accessToken`, `appToken`, `apiToken`, `botToken`, `refreshToken`, `secret`, `clientSecret`, `apiKey`, `secretAccessKey`, `accessKey`, `licenseKey`, `userKey`, `privateKey`, `privateKeyPass`, `encPrivateKey`, `encPrivateKeyPass`, `sshKey`, `sshPrivateKey`, `customGitSSHKey`, `dockerAuth`. |
+
+For Dokploy instances behind Cloudflare Access or a similar reverse proxy, pass service-token headers with placeholder values like this:
+
+```bash
+DOKPLOY_CUSTOM_HEADERS='{"CF-Access-Client-Id":"your-client-id.access","CF-Access-Client-Secret":"your-client-secret"}'
+```
 
 ## Transport Modes
 

package/build/generated/tools.js

@@ -1,5 +1,5 @@
 // AUTO-GENERATED FILE — DO NOT EDIT MANUALLY
-// Generated from openapi.json on 2026-04-17
+// Generated from openapi.json on 2026-04-25
 // Run `pnpm generate` to regenerate
 import { z } from "zod";
 export const generatedTools = [
@@ -1269,12 +1269,48 @@ export const generatedTools = [
         tag: "docker",
         method: "POST",
         path: "/docker.restartContainer",
-        schema: z.object({ "containerId": z.string().regex(new RegExp("^[a-zA-Z0-9.\\-_]+$")).min(1) }),
+        schema: z.object({ "containerId": z.string().regex(new RegExp("^[a-zA-Z0-9.\\-_]+$")).min(1), "serverId": z.string().optional() }),
         annotations: {
             title: "Docker RestartContainer",
             ...{ "idempotentHint": true, "openWorldHint": true },
         },
     },
+    {
+        name: "docker-startContainer",
+        description: "POST /docker.startContainer",
+        tag: "docker",
+        method: "POST",
+        path: "/docker.startContainer",
+        schema: z.object({ "containerId": z.string().regex(new RegExp("^[a-zA-Z0-9.\\-_]+$")).min(1), "serverId": z.string().optional() }),
+        annotations: {
+            title: "Docker StartContainer",
+            ...{ "idempotentHint": true, "openWorldHint": true },
+        },
+    },
+    {
+        name: "docker-stopContainer",
+        description: "POST /docker.stopContainer",
+        tag: "docker",
+        method: "POST",
+        path: "/docker.stopContainer",
+        schema: z.object({ "containerId": z.string().regex(new RegExp("^[a-zA-Z0-9.\\-_]+$")).min(1), "serverId": z.string().optional() }),
+        annotations: {
+            title: "Docker StopContainer",
+            ...{ "idempotentHint": true, "openWorldHint": true },
+        },
+    },
+    {
+        name: "docker-killContainer",
+        description: "POST /docker.killContainer",
+        tag: "docker",
+        method: "POST",
+        path: "/docker.killContainer",
+        schema: z.object({ "containerId": z.string().regex(new RegExp("^[a-zA-Z0-9.\\-_]+$")).min(1), "serverId": z.string().optional() }),
+        annotations: {
+            title: "Docker KillContainer",
+            ...{ "idempotentHint": true, "openWorldHint": true },
+        },
+    },
     {
         name: "docker-removeContainer",
         description: "POST /docker.removeContainer",
@@ -3411,6 +3447,18 @@ export const generatedTools = [
             ...{ "readOnlyHint": true, "idempotentHint": true, "openWorldHint": true },
         },
     },
+    {
+        name: "project-homeStats",
+        description: "GET /project.homeStats",
+        tag: "project",
+        method: "GET",
+        path: "/project.homeStats",
+        schema: z.object({}),
+        annotations: {
+            title: "Project HomeStats",
+            ...{ "readOnlyHint": true, "idempotentHint": true, "openWorldHint": true },
+        },
+    },
     {
         name: "project-search",
         description: "GET /project.search",
@@ -4803,6 +4851,18 @@ export const generatedTools = [
             ...{ "readOnlyHint": true, "idempotentHint": true, "openWorldHint": true },
         },
     },
+    {
+        name: "stripe-updateInvoiceNotifications",
+        description: "POST /stripe.updateInvoiceNotifications",
+        tag: "stripe",
+        method: "POST",
+        path: "/stripe.updateInvoiceNotifications",
+        schema: z.object({ "enabled": z.boolean() }),
+        annotations: {
+            title: "Stripe UpdateInvoiceNotifications",
+            ...{ "idempotentHint": true, "openWorldHint": true },
+        },
+    },
     {
         name: "stripe-getInvoices",
         description: "GET /stripe.getInvoices",
@@ -4965,7 +5025,7 @@ export const generatedTools = [
         tag: "user",
         method: "POST",
         path: "/user.update",
-        schema: z.object({ "id": z.string().min(1).optional(), "firstName": z.string().optional(), "lastName": z.string().optional(), "isRegistered": z.boolean().optional(), "expirationDate": z.string().optional(), "createdAt2": z.string().optional(), "createdAt": z.union([z.string(), z.null()]).optional(), "twoFactorEnabled": z.union([z.boolean(), z.null()]).optional(), "email": z.string().email().regex(new RegExp("^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$")).min(1).optional(), "emailVerified": z.boolean().optional(), "image": z.union([z.string(), z.null()]).optional(), "banned": z.union([z.boolean(), z.null()]).optional(), "banReason": z.union([z.string(), z.null()]).optional(), "banExpires": z.union([z.string(), z.null()]).optional(), "updatedAt": z.string().optional(), "enablePaidFeatures": z.boolean().optional(), "allowImpersonation": z.boolean().optional(), "enableEnterpriseFeatures": z.boolean().optional(), "licenseKey": z.union([z.string(), z.null()]).optional(), "stripeCustomerId": z.union([z.string(), z.null()]).optional(), "stripeSubscriptionId": z.union([z.string(), z.null()]).optional(), "serversQuantity": z.number().optional(), "password": z.string().optional(), "currentPassword": z.string().optional() }),
+        schema: z.object({ "id": z.string().min(1).optional(), "firstName": z.string().optional(), "lastName": z.string().optional(), "isRegistered": z.boolean().optional(), "expirationDate": z.string().optional(), "createdAt2": z.string().optional(), "createdAt": z.union([z.string(), z.null()]).optional(), "twoFactorEnabled": z.union([z.boolean(), z.null()]).optional(), "email": z.string().email().regex(new RegExp("^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$")).min(1).optional(), "emailVerified": z.boolean().optional(), "image": z.union([z.string(), z.null()]).optional(), "banned": z.union([z.boolean(), z.null()]).optional(), "banReason": z.union([z.string(), z.null()]).optional(), "banExpires": z.union([z.string(), z.null()]).optional(), "updatedAt": z.string().optional(), "enablePaidFeatures": z.boolean().optional(), "allowImpersonation": z.boolean().optional(), "enableEnterpriseFeatures": z.boolean().optional(), "licenseKey": z.union([z.string(), z.null()]).optional(), "stripeCustomerId": z.union([z.string(), z.null()]).optional(), "stripeSubscriptionId": z.union([z.string(), z.null()]).optional(), "serversQuantity": z.number().optional(), "sendInvoiceNotifications": z.boolean().optional(), "password": z.string().optional(), "currentPassword": z.string().optional() }),
         annotations: {
             title: "User Update",
             ...{ "idempotentHint": true, "openWorldHint": true },

package/build/handler.js

@@ -1,15 +1,19 @@
 import apiClient from "./utils/apiClient.js";
+import { getClientConfig } from "./utils/clientConfig.js";
 import { createLogger } from "./utils/logger.js";
+import { redactSensitive } from "./utils/redactSensitive.js";
 import { ResponseFormatter } from "./utils/responseFormatter.js";
 const logger = createLogger("ToolHandler");
 export function createHandler(tool) {
     return async (input) => {
+        const { redactEnv, redactFields } = getClientConfig();
+        const redact = (value) => (redactEnv ? redactSensitive(value, redactFields) : value);
         try {
-            logger.info(`Executing tool: ${tool.name}`, { input });
+            logger.info(`Executing tool: ${tool.name}`, { input: redact(input) });
             const response = tool.method === "GET"
                 ? await apiClient.get(tool.path, { params: input })
                 : await apiClient.post(tool.path, input);
-            return ResponseFormatter.success(`${tool.name} completed successfully`, response.data);
+            return ResponseFormatter.success(`${tool.name} completed successfully`, redact(response.data));
         }
         catch (error) {
             logger.error(`Tool execution failed: ${tool.name}`, {

package/build/server.js

@@ -1,8 +1,11 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { ListToolsRequestSchema } from "@modelcontextprotocol/sdk/types.js";
+import { zodToJsonSchema } from "zod-to-json-schema";
 import { generatedTools } from "./generated/tools.js";
 import { createHandler } from "./handler.js";
 import { createLogger } from "./utils/logger.js";
 const logger = createLogger("MCP-Server");
+const JSON_SCHEMA_2020_12 = "https://json-schema.org/draft/2020-12/schema";
 function getEnabledTools() {
     const enabledTags = process.env.DOKPLOY_ENABLED_TAGS;
     if (!enabledTags) {
@@ -20,6 +23,38 @@ function getEnabledTools() {
     });
     return filtered;
 }
+function stripNestedSchemaKeys(value) {
+    if (value === null || typeof value !== "object")
+        return;
+    if (Array.isArray(value)) {
+        for (const item of value)
+            stripNestedSchemaKeys(item);
+        return;
+    }
+    const record = value;
+    for (const key of Object.keys(record)) {
+        if (key === "$schema") {
+            delete record[key];
+        }
+        else {
+            stripNestedSchemaKeys(record[key]);
+        }
+    }
+}
+// Claude's API requires JSON Schema draft 2020-12. The MCP SDK's built-in
+// Zod→JSON Schema converter emits draft-07 by default, which causes a 400
+// error on tools/list. We bypass the SDK's auto-generated handler by
+// registering our own with pre-converted draft-2020-12 schemas.
+// See https://github.com/Dokploy/mcp/issues/32
+function toDraft2020_12JsonSchema(schema) {
+    const result = zodToJsonSchema(schema, {
+        target: "jsonSchema2019-09",
+        strictUnions: true,
+    });
+    stripNestedSchemaKeys(result);
+    result.$schema = JSON_SCHEMA_2020_12;
+    return result;
+}
 export function createServer() {
     const server = new McpServer({
         name: "dokploy",
@@ -29,5 +64,14 @@ export function createServer() {
     for (const tool of tools) {
         server.tool(tool.name, tool.description, tool.schema.shape, tool.annotations ?? {}, createHandler(tool));
     }
+    const toolList = tools.map((tool) => ({
+        name: tool.name,
+        description: tool.description,
+        inputSchema: toDraft2020_12JsonSchema(tool.schema),
+        annotations: tool.annotations,
+    }));
+    server.server.setRequestHandler(ListToolsRequestSchema, async () => ({
+        tools: toolList,
+    }));
     return server;
 }

package/build/utils/apiClient.js

@@ -9,7 +9,8 @@ const config = getClientConfig();
 const DEFAULT_HEADERS = {
     "Content-Type": "application/json",
     Accept: "application/json",
-    "x-api-key": config.authToken, // Use the same auth mechanism as httpClient
+    ...config.customHeaders,
+    "x-api-key": config.authToken,
 };
 // Create axios instance with configuration from clientConfig
 // Ensure baseURL includes /api prefix for Dokploy API routes

package/build/utils/clientConfig.js

@@ -1,3 +1,34 @@
+import { DEFAULT_REDACTED_FIELDS } from "./redactSensitive.js";
+const RESERVED_CUSTOM_HEADER_NAMES = new Set(["x-api-key", "content-type", "accept"]);
+export function parseCustomHeaders(rawHeaders) {
+    if (rawHeaders === undefined) {
+        return {};
+    }
+    let parsed;
+    try {
+        parsed = JSON.parse(rawHeaders);
+    }
+    catch (error) {
+        throw new Error("Environment variable DOKPLOY_CUSTOM_HEADERS must be valid JSON containing an object of string header names to string values", { cause: error });
+    }
+    if (parsed === null || typeof parsed !== "object" || Array.isArray(parsed)) {
+        throw new Error("Environment variable DOKPLOY_CUSTOM_HEADERS must be a JSON object of string header names to string values");
+    }
+    const customHeaders = {};
+    for (const [name, value] of Object.entries(parsed)) {
+        if (name.trim() === "") {
+            throw new Error("Environment variable DOKPLOY_CUSTOM_HEADERS contains an empty header name");
+        }
+        if (RESERVED_CUSTOM_HEADER_NAMES.has(name.toLowerCase())) {
+            throw new Error("Environment variable DOKPLOY_CUSTOM_HEADERS cannot override reserved headers x-api-key, content-type, or accept; configure Dokploy authentication with DOKPLOY_API_KEY");
+        }
+        if (typeof value !== "string") {
+            throw new Error("Environment variable DOKPLOY_CUSTOM_HEADERS must contain only string header values");
+        }
+        customHeaders[name] = value;
+    }
+    return customHeaders;
+}
 class ConfigManager {
     static instance;
     config = null;
@@ -23,15 +54,33 @@ class ConfigManager {
         if (!authToken) {
             throw new Error("Environment variable DOKPLOY_API_KEY is not defined");
         }
+        const redactEnv = parseBoolean(process.env.DOKPLOY_REDACT_ENV, false);
+        const parsedFields = process.env.DOKPLOY_REDACT_FIELDS?.split(",")
+            .map((f) => f.trim())
+            .filter((f) => f.length > 0) ?? [];
+        const redactFields = parsedFields.length > 0 ? parsedFields : DEFAULT_REDACTED_FIELDS;
         return {
             dokployUrl,
             authToken,
+            customHeaders: parseCustomHeaders(process.env.DOKPLOY_CUSTOM_HEADERS),
             timeout: parseInt(process.env.DOKPLOY_TIMEOUT || "30000", 10),
             retryAttempts: parseInt(process.env.DOKPLOY_RETRY_ATTEMPTS || "3", 10),
             retryDelay: parseInt(process.env.DOKPLOY_RETRY_DELAY || "1000", 10),
+            redactEnv,
+            redactFields,
         };
     }
 }
 export function getClientConfig() {
     return ConfigManager.getInstance().getConfig();
 }
+function parseBoolean(value, fallback) {
+    if (value === undefined)
+        return fallback;
+    const normalized = value.trim().toLowerCase();
+    if (["true", "1", "yes", "on"].includes(normalized))
+        return true;
+    if (["false", "0", "no", "off", ""].includes(normalized))
+        return false;
+    return fallback;
+}

package/build/utils/redactSensitive.js

@@ -0,0 +1,80 @@
+export const DEFAULT_REDACTED_FIELDS = [
+    "env",
+    "buildArgs",
+    "composeFile",
+    "dockerCompose",
+    "environment",
+    "buildSecrets",
+    "previewBuildSecrets",
+    "password",
+    "currentPassword",
+    "appPassword",
+    "databasePassword",
+    "databaseRootPassword",
+    "redisPassword",
+    "mariadbPassword",
+    "mongoPassword",
+    "mysqlPassword",
+    "postgresPassword",
+    "registryPassword",
+    "token",
+    "accessToken",
+    "appToken",
+    "apiToken",
+    "botToken",
+    "refreshToken",
+    "secret",
+    "clientSecret",
+    "apiKey",
+    "secretAccessKey",
+    "accessKey",
+    "licenseKey",
+    "userKey",
+    "privateKey",
+    "privateKeyPass",
+    "encPrivateKey",
+    "encPrivateKeyPass",
+    "sshKey",
+    "sshPrivateKey",
+    "customGitSSHKey",
+    "dockerAuth",
+];
+const REDACTED_PLACEHOLDER = "[REDACTED]";
+export function redactSensitive(data, fields) {
+    if (fields.length === 0)
+        return data;
+    const lowered = new Set(fields.map((f) => f.toLowerCase()));
+    return walk(data, lowered, new WeakSet());
+}
+function isPlainObject(value) {
+    if (value === null || typeof value !== "object")
+        return false;
+    const proto = Object.getPrototypeOf(value);
+    return proto === Object.prototype || proto === null;
+}
+function walk(value, fields, seen) {
+    if (Array.isArray(value)) {
+        if (seen.has(value))
+            return value;
+        seen.add(value);
+        return value.map((item) => walk(item, fields, seen));
+    }
+    if (isPlainObject(value)) {
+        if (seen.has(value))
+            return value;
+        seen.add(value);
+        const out = Object.create(null);
+        for (const [key, val] of Object.entries(value)) {
+            if (key === "__proto__" || key === "constructor" || key === "prototype")
+                continue;
+            if (fields.has(key.toLowerCase())) {
+                out[key] = val === null || val === undefined ? val : REDACTED_PLACEHOLDER;
+            }
+            else {
+                out[key] = walk(val, fields, seen);
+            }
+        }
+        return out;
+    }
+    return value;
+}

package/build/utils/responseFormatter.js

@@ -3,7 +3,7 @@ export class ResponseFormatter {
         const responseData = {
             success: true,
             message,
-            ...(data && typeof data === "object" && data !== null ? { data } : {}),
+            ...(data !== undefined && data !== null ? { data } : {}),
         };
         return {
             content: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dokploy/mcp",
-  "version": "v0.29.0",
+  "version": "0.29.3",
   "description": "MCP Server for Dokploy API",
   "main": "build/index.js",
   "bin": {
@@ -30,14 +30,16 @@
     "@modelcontextprotocol/sdk": "^1.12.0",
     "axios": "^1.9.0",
     "hono": "^4.12.12",
-    "zod": "^3.25.28"
+    "zod": "^3.25.28",
+    "zod-to-json-schema": "^3.25.2"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.4.10",
     "@types/node": "^22.15.21",
     "json-schema-to-zod": "^2.8.1",
     "tsx": "^4.21.0",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "vitest": "^4.1.6"
   },
   "scripts": {
     "build": "pnpm run clean && tsc && chmod 755 build/index.js",
@@ -57,6 +59,6 @@
     "type-check": "tsc --noEmit",
     "clean": "rm -rf build",
     "precommit": "biome check && pnpm run type-check",
-    "test": "echo \"Error: no test spcified\" && exit 1"
+    "test": "vitest run"
   }
 }