Skip to content

About

A Model Context Protocol (MCP) server for Dokploy with automatic secret redaction — every API response is masked (env vars, passwords, tokens, private keys, webhook URLs) so AI agents can manage a Dokploy instance without ever reading its credentials. Fork of tacticlaunch/dokploy-mcp.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

 
 

Repository files navigation

Dokploy MCP Server — Jcorderop02 fork

This repository is a maintained fork of tacticlaunch/dokploy-mcp. It tracks the Dokploy API contract used by Dokploy v0.30.2 and is published from this fork as version 1.1.0.

See CHANGELOG.md for the changes in each release.

A comprehensive Model Context Protocol (MCP) server for Dokploy, providing type-safe access to the complete Dokploy API with extensive tool coverage across all available endpoints.

Features

  • 490 Tools covering the available Dokploy API operations in the tracked OpenAPI contract
  • Smart tool selection with core tools enabled by default
  • Advanced tools available but disabled by default for performance
  • Type-safe integration with auto-generated OpenAPI types
  • Environment-based authentication
  • Modular architecture with each tool in separate files
  • Comprehensive error handling for all HTTP status codes
  • Production-ready MCP server with optimized tool selection

📋 See TOOLS_STATUS.md for complete tool breakdown and current status

Featured security

Dokploy MCP redacts sensitive values before returning any API response to the AI model. Environment variables, passwords, tokens, API keys, private keys and other secrets are returned as ******** instead of their real value:

{
  "env": "********",
  "token": "********",
  "password": "********"
}

The MCP can still manage these resources without exposing their credentials to the model.

Installation

npx -y dokploy-mcp

Configuration

Set the following environment variables:

export DOKPLOY_URL="https://your-dokploy-instance.com"
export DOKPLOY_API_KEY="your-api-key-here"

Getting Your API Key

You can create an API key in your Dokploy dashboard:

  1. Go to Settings → Profile in your Dokploy dashboard
  2. Navigate to /dashboard/settings/profile
  3. Generate a new API key
  4. Copy the key and use it as the DOKPLOY_API_KEY environment variable

Usage with Claude Desktop

Add to your Claude Desktop configuration:

{
  "mcpServers": {
    "dokploy": {
      "command": "npx",
      "args": ["-y", "dokploy-mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-instance.com",
        "DOKPLOY_API_KEY": "your-api-key-here"
      }
    }
  }
}

Available Tools

For a complete list of all available tools, their descriptions, and current status, see:

📋 TOOLS_STATUS.md - Complete tool reference with status and management instructions

Tool Management

Runtime Tool Control

You can control which tools are enabled/disabled at runtime using command-line arguments or environment variables:

Enable Additional Tools

# Enable specific tools or categories
npx -y dokploy-mcp --enable-tools postgres/,application-cancelDeployment

# Enable multiple categories
npx -y dokploy-mcp --enable-tools postgres/,mysql/,notification/

Disable Specific Tools

# Disable specific tools or categories
XMCP_DISABLE_TOOLS=admin/,application-cancelDeployment npx -y dokploy-mcp

# Disable multiple categories
XMCP_DISABLE_TOOLS=admin/,settings/,stripe/ npx -y dokploy-mcp

Claude Desktop Configuration

{
  "mcpServers": {
    "dokploy": {
      "command": "npx",
      "args": ["-y", "dokploy-mcp", "--enable-tools", "postgres/,mysql/"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-instance.com",
        "DOKPLOY_API_KEY": "your-api-key-here",
        "XMCP_DISABLE_TOOLS": "admin/,stripe/"
      }
    }
  }
}

Tool Patterns

  • Category patterns: postgres/, mysql/, notification/ - enables/disables entire categories
  • Specific tools: application-cancelDeployment, server-create - enables/disables individual tools
  • Multiple patterns: Separate with commas: postgres/,mysql/,application-cancelDeployment

Tool Categories

For detailed information about tool categories and their current status, see TOOLS_STATUS.md.

Development Mode

To enable additional tools permanently, modify the disabled property in each tool's metadata:

export const metadata: ToolMetadata = {
  name: 'tool-name',
  description: 'Tool description',
  annotations: {
    title: 'Tool Title',
    destructiveHint: false,
    idempotentHint: true,
  },
  disabled: false, // Set to false to enable, true to disable
}

Documentation

Development

# Install dependencies
pnpm install

# Build the project (automatically updates TOOLS_STATUS.md)
pnpm build

# Run contract tests against the tracked OpenAPI document
pnpm test

# Update tools status manually
pnpm run update-tools-status

# Run in development
pnpm dev

Fork and license

This project is a fork maintained by Jcorderop02. The original MIT license and copyright notice are retained in LICENSE.

MIT

About

A Model Context Protocol (MCP) server for Dokploy with automatic secret redaction — every API response is masked (env vars, passwords, tokens, private keys, webhook URLs) so AI agents can manage a Dokploy instance without ever reading its credentials. Fork of tacticlaunch/dokploy-mcp.

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages