Skip to content
Back to search

mcp

The Official MCP package for Dokploy

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today

Check it deeper on your machine

It has changed since its scan on 11 Nov 2026.

As a Claude Code plugin, install it and then ask Claude Code:

/plugin marketplace add keithmackay/mackayi/plugin install scanskillsafety@mackayiDo a deep scan of https://github.com/Dokploy/mcp with scanskillsafety

Or from a terminal, clone it and run it:

git clone https://github.com/keithmackay/scanskillsafety-skill ~/.claude/skills/scanskillsafetynode ~/.claude/skills/scanskillsafety/cli.cjs --deep 'https://github.com/Dokploy/mcp'

It checks the exact commit: every file, its packages against OSV (api.osv.dev), how it compares with this page's scan (findsafeskills.com receives the repository's address), and, if you agree, Claude reading every file with your own Claude subscription. It never runs the code.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/dokploy--mcp/badge.svg)](/listings/dokploy--mcp)

HTML

<a href="/listings/dokploy--mcp"><img src="/api/listings/dokploy--mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Requirements

- Node.js >= v18.0.0 (or Docker) - Cursor, VS Code, Claude Desktop, or another MCP Client - A running Dokploy server instance

Install in Cursor

Go to: `Settings` -> `Cursor Settings` -> `MCP` -> `Add new global MCP server`

Add this to your Cursor `~/.cursor/mcp.json` file. You may also install in a specific project by creating `.cursor/mcp.json` in your project folder. See [Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol) for more info.

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

<details> <summary>Alternative: Use Bun</summary>

{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "bunx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

</details>

<details> <summary>Alternative: Use Deno</summary>

{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "deno",
      "args": ["run", "--allow-env", "--allow-net", "npm:@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

</details>

Install in Windsurf

Add this to your Windsurf MCP config file. See [Windsurf MCP docs](https://docs.windsurf.com/windsurf/mcp) for more info.

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

Install in VS Code

[<img alt="Install in VS Code (npx)" src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Dokploy%20MCP&color=0098FF">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22dokploy-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40dokploy%2Fmcp%40latest%22%5D%7D) [<img alt="Install in VS Code Insiders (npx)" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Dokploy%20MCP&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%7B%22name%22%3A%22dokploy-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40dokploy%2Fmcp%40latest%22%5D%7D)

Add this to your VS Code MCP config file. See [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more info.

{
  "servers": {
    "dokploy-mcp": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

Install in Claude Code

Add the MCP server to Claude Code using the CLI:

claude mcp add dokploy-mcp -- npx -y @dokploy/mcp

Then set the environment variables in your `.claude/settings.json` or pass them inline:

DOKPLOY_URL=https://your-dokploy-server.com DOKPLOY_API_KEY=your-token claude

Install in Zed

Add this to your Zed `settings.json`. See [Zed Context Server docs](https://zed.dev/docs/assistant/context-servers) for more info.

{
  "context_servers": {
    "dokploy-mcp": {
      "command": "npx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}

Install in Claude Desktop

Add this to your Claude Desktop `claude_desktop_config.json` file. See [Claude Desktop MCP docs](https://modelcontextprotocol.io/quickstart/user) for more info.

{
  "mcpServers": {

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 563 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # Dokploy MCP Server
  2. [![npm version](https://img.shields.io/npm/v/@dokploy/mcp.svg)](https://www.npmjs.com/package/@dokploy/mcp) [<img alt="Install in VS Code (npx)" src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Dokploy%20MCP&color=0098FF">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22dokploy-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40dokploy%2Fmcp%40latest%22%5D%7D)
  3. Dokploy MCP Server exposes **all Dokploy API endpoints** as tools consumable via the Model Context Protocol (MCP). It allows MCP-compatible clients (e.g., AI models, other applications) to interact with your Dokploy server programmatically.
  4. With **508 tools** across **49 categories**, this server provides complete coverage of the Dokploy API — from project and application management to databases, notifications, SSO, Docker, backups, and more.
  5. ## Getting Started
  6. ### Requirements
  7. - Node.js >= v18.0.0 (or Docker)
  8. - Cursor, VS Code, Claude Desktop, or another MCP Client
  9. - A running Dokploy server instance
  10. ### Install in Cursor
  11. Go to: `Settings` -> `Cursor Settings` -> `MCP` -> `Add new global MCP server`
  12. Add this to your Cursor `~/.cursor/mcp.json` file. You may also install in a specific project by creating `.cursor/mcp.json` in your project folder. See [Cursor MCP docs](https://docs.cursor.com/context/model-context-protocol) for more info.
  13. ```json
  14. {
  15. "mcpServers": {
  16. "dokploy-mcp": {
  17. "command": "npx",
  18. "args": ["-y", "@dokploy/mcp"],
  19. "env": {
  20. "DOKPLOY_URL": "https://your-dokploy-server.com",
  21. "DOKPLOY_API_KEY": "your-dokploy-api-token"
  22. }
  23. }
  24. }
  25. }
  26. ```
  27. <details>
  28. <summary>Alternative: Use Bun</summary>
  29. ```json
  30. {
  31. "mcpServers": {
  32. "dokploy-mcp": {
  33. "command": "bunx",
  34. "args": ["-y", "@dokploy/mcp"],
  35. "env": {
  36. "DOKPLOY_URL": "https://your-dokploy-server.com",
  37. "DOKPLOY_API_KEY": "your-dokploy-api-token"
  38. }
  39. }
  40. }
  41. }
  42. ```
  43. </details>
  44. <details>
  45. <summary>Alternative: Use Deno</summary>
  46. ```json
  47. {
  48. "mcpServers": {
  49. "dokploy-mcp": {
  50. "command": "deno",
  51. "args": ["run", "--allow-env", "--allow-net", "npm:@dokploy/mcp"],
  52. "env": {
  53. "DOKPLOY_URL": "https://your-dokploy-server.com",
  54. "DOKPLOY_API_KEY": "your-dokploy-api-token"
  55. }
  56. }
  57. }
  58. }
  59. ```
  60. </details>
  61. ### Install in Windsurf
  62. Add this to your Windsurf MCP config file. See [Windsurf MCP docs](https://docs.windsurf.com/windsurf/mcp) for more info.
  63. ```json
  64. {
  65. "mcpServers": {
  66. "dokploy-mcp": {
  67. "command": "npx",
  68. "args": ["-y", "@dokploy/mcp"],
  69. "env": {
  70. "DOKPLOY_URL": "https://your-dokploy-server.com",
  71. "DOKPLOY_API_KEY": "your-dokploy-api-token"
  72. }
  73. }
  74. }
  75. }
  76. ```
  77. ### Install in VS Code
  78. [<img alt="Install in VS Code (npx)" src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Dokploy%20MCP&color=0098FF">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%7B%22name%22%3A%22dokploy-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40dokploy%2Fmcp%40latest%22%5D%7D)
  79. [<img alt="Install in VS Code Insiders (npx)" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Dokploy%20MCP&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%7B%22name%22%3A%22dokploy-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40dokploy%2Fmcp%40latest%22%5D%7D)
  80. Add this to your VS Code MCP config file. See [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) for more info.
  81. ```json
  82. {
  83. "servers": {
  84. "dokploy-mcp": {
  85. "type": "stdio",
  86. "command": "npx",
  87. "args": ["-y", "@dokploy/mcp"],
  88. "env": {
  89. "DOKPLOY_URL": "https://your-dokploy-server.com",
  90. "DOKPLOY_API_KEY": "your-dokploy-api-token"
  91. }
  92. }
  93. }
  94. }
  95. ```
  96. ### Install in Claude Code
  97. Add the MCP server to Claude Code using the CLI:
  98. ```bash
  99. claude mcp add dokploy-mcp -- npx -y @dokploy/mcp
  100. ```
  101. Then set the environment variables in your `.claude/settings.json` or pass them inline:
  102. ```bash
  103. DOKPLOY_URL=https://your-dokploy-server.com DOKPLOY_API_KEY=your-token claude
  104. ```
  105. ### Install in Zed
  106. Add this to your Zed `settings.json`. See [Zed Context Server docs](https://zed.dev/docs/assistant/context-servers) for more info.
  107. ```json
  108. {
  109. "context_servers": {
  110. "dokploy-mcp": {
  111. "command": "npx",
  112. "args": ["-y", "@dokploy/mcp"],
  113. "env": {
  114. "DOKPLOY_URL": "https://your-dokploy-server.com",
  115. "DOKPLOY_API_KEY": "your-dokploy-api-token"
  116. }
  117. }
  118. }
  119. }
  120. ```
  121. ### Install in Claude Desktop
  122. Add this to your Claude Desktop `claude_desktop_config.json` file. See [Claude Desktop MCP docs](https://modelcontextprotocol.io/quickstart/user) for more info.
  123. ```json
  124. {
  125. "mcpServers": {
  126. "dokploy-mcp": {
  127. "command": "npx",
  128. "args": ["-y", "@dokploy/mcp"],
  129. "env": {
  130. "DOKPLOY_URL": "https://your-dokploy-server.com",
  131. "DOKPLOY_API_KEY": "your-dokploy-api-token"
  132. }
  133. }
  134. }
  135. }
  136. ```
  137. ### Install in BoltAI
  138. Open the "Settings" page of the app, navigate to "Plugins," and enter the following JSON:
  139. ```json
  140. {
  141. "mcpServers": {
  142. "dokploy-mcp": {
  143. "command": "npx",
  144. "args": ["-y", "@dokploy/mcp"],
  145. "env": {
  146. "DOKPLOY_URL": "https://your-dokploy-server.com",
  147. "DOKPLOY_API_KEY": "your-dokploy-api-token"
  148. }
  149. }
  150. }
  151. }
  152. ```
  153. ### Install in Opencode
  154. Add this to your OpenCode configuration (located by default in ~/.config/opencode/opencode.json or opencode.json for local/project config). See [Opencode MCP config](https://opencode.ai/docs/mcp-servers/) for more info.
  155. ```json
  156. {
  157. "mcp": {
  158. "dokploy": {
  159. "type": "local",
  160. "command": ["npx", "-y", "@dokploy/mcp"],
  161. "environment": {
  162. "DOKPLOY_URL": "https://your-dokploy-server.com",
  163. "DOKPLOY_API_KEY": "your-dokploy-api-token"
  164. },
  165. "enabled": true
  166. }
  167. }
  168. }
  169. ```
  170. ### Using Docker
  171. The Docker container supports both **stdio** and **HTTP** transport modes, making it flexible for different deployment scenarios.
  172. 1. **Build the Docker Image:**
  173. ```bash
  174. git clone https://github.com/Dokploy/mcp.git
  175. cd mcp
  176. docker build -t dokploy-mcp .
  177. ```
  178. 2. **Manual Docker Commands:**
  179. **Stdio Mode (for MCP clients):**
  180. ```bash
  181. docker run -it --rm \
  182. -e DOKPLOY_URL=https://your-dokploy-server.com \
  183. -e DOKPLOY_API_KEY=your_token_here \
  184. dokploy-mcp
  185. ```
  186. **HTTP Mode (for web applications):**
  187. ```bash
  188. docker run -it --rm \
  189. -p 8080:3000 \
  190. -e MCP_TRANSPORT=http \
  191. -e DOKPLOY_URL=https://your-dokploy-server.com \
  192. -e DOKPLOY_API_KEY=your_token_here \
  193. dokploy-mcp
  194. ```
  195. 3. **Docker Compose:**
  196. Use the provided `docker-compose.yml` for production deployments:
  197. ```bash
  198. # Start HTTP service
  199. docker-compose up -d dokploy-mcp-http
  200. # View logs
  201. docker-compose logs -f dokploy-mcp-http
  202. ```
  203. 4. **MCP Client Configuration:**
  204. **For stdio mode (Claude Desktop, VS Code, etc.):**
  205. ```json
  206. {
  207. "mcpServers": {
  208. "dokploy-mcp": {
  209. "command": "docker",
  210. "args": [
  211. "run",
  212. "-i",
  213. "--rm",
  214. "-e",
  215. "DOKPLOY_URL=https://your-dokploy-server.com",
  216. "-e",
  217. "DOKPLOY_API_KEY=your_token_here",
  218. "dokploy-mcp"
  219. ]
  220. }
  221. }
  222. }
  223. ```
  224. **For HTTP mode (web applications):**
  225. Start the HTTP server first, then configure your client to connect to `http://localhost:3000/mcp`.
  226. ### Install in Windows
  227. The configuration on Windows is slightly different compared to Linux or macOS. Use `cmd` as the command wrapper:
  228. ```json
  229. {
  230. "mcpServers": {
  231. "dokploy-mcp": {
  232. "command": "cmd",
  233. "args": ["/c", "npx", "-y", "@dokploy/mcp"],
  234. "env": {
  235. "DOKPLOY_URL": "https://your-dokploy-server.com",
  236. "DOKPLOY_API_KEY": "your-dokploy-api-token"
  237. }
  238. }
  239. }
  240. }
  241. ```
  242. ### Environment Variables
  243. | Variable | Required | Description |
  244. |----------|----------|-------------|
  245. | `DOKPLOY_URL` | Yes | Your Dokploy server URL (e.g., `https://your-dokploy-server.com`) |
  246. | `DOKPLOY_API_KEY` | Yes | Your Dokploy API authentication token |
  247. | `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`. |
  248. | `DOKPLOY_TOOL_PRESET` | No | Predefined toolset to load: `all` (default), `minimal`, `core`, `deploy`, `databases`, or `git`. Useful for clients/providers that struggle with very large tool lists. |
  249. | `DOKPLOY_ENABLED_TAGS` | No | Comma-separated list of tags to filter which tools are loaded (e.g., `project,application,postgres`) |
  250. | `DOKPLOY_DISABLED_TAGS` | No | Comma-separated list of tags to exclude from the selected toolset. Applied after `DOKPLOY_TOOL_PRESET` or `DOKPLOY_ENABLED_TAGS`. |
  251. | `DOKPLOY_TIMEOUT` | No | Request timeout in milliseconds (default: `30000`) |
  252. | `DOKPLOY_RETRY_ATTEMPTS` | No | Number of retry attempts (default: `3`) |
  253. | `DOKPLOY_RETRY_DELAY` | No | Delay between retries in milliseconds (default: `1000`) |
  254. | `DOKPLOY_REDACT_ENV` | No | Redacts secret-bearing fields (env vars, compose files, passwords, tokens, keys) from API responses before they reach the MCP client (default: `true`). Set to `false` only if you explicitly need raw secret values in LLM context. |
  255. | `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`. |
  256. For Dokploy instances behind Cloudflare Access or a similar reverse proxy, pass service-token headers with placeholder values like this:
  257. ```bash
  258. DOKPLOY_CUSTOM_HEADERS='{"CF-Access-Client-Id":"your-client-id.access","CF-Access-Client-Secret":"your-client-secret"}'
  259. ```
  260. ## Transport Modes
  261. This MCP server supports multiple transport modes to suit different use cases:
  262. ### Stdio Mode (Default)
  263. The default mode uses stdio for direct process communication, ideal for desktop applications and command-line usage.
  264. ```bash
  265. # Run with stdio (default)
  266. npx -y @dokploy/mcp
  267. ```
  268. ### HTTP Mode (Streamable HTTP + Legacy SSE)
  269. Modern HTTP mode exposes the server via HTTP/HTTPS supporting **both modern and legacy protocols** for maximum compatibility:
  270. - **Streamable HTTP (MCP 2025-03-26)** - Modern protocol with session management
  271. - **Legacy SSE (MCP 2024-11-05)** - Backwards compatibility for older clients
  272. ```bash
  273. # Run with HTTP mode
  274. npx -y @dokploy/mcp --http
  275. # or via environment variable
  276. MCP_TRANSPORT=http npx -y @dokploy/mcp
  277. ```
  278. **Modern Streamable HTTP Endpoints:**
  279. | Endpoint | Method | Description |
  280. |----------|--------|-------------|
  281. | `/mcp` | POST | Client-to-server requests |
  282. | `/mcp` | GET | Server-to-client notifications (SSE) |
  283. | `/mcp` | DELETE | Session termination |
  284. | `/health` | GET | Health check |
  285. **Legacy SSE Endpoints (Backwards Compatibility):**
  286. | Endpoint | Method | Description |
  287. |----------|--------|-------------|
  288. | `/sse` | GET | SSE stream initialization |
  289. | `/messages` | POST | Client message posting |
  290. ## Available Tools (508)
  291. This MCP server provides **508 tools** covering the entire Dokploy API, organized into **49 categories**:
  292. ### Core Resources
  293. | Category | Tools | Description |
  294. |----------|-------|-------------|
  295. | **Project** | 8 | Create, list, update, duplicate, search, and delete projects |
  296. | **Application** | 30 | Full application lifecycle — create, deploy, redeploy, start, stop, build types, git providers (GitHub, GitLab, Bitbucket, Gitea), environment, Traefik config |
  297. | **Compose** | 29 | Docker Compose management — create, deploy, templates, services, environment, isolated deployments |
  298. | **Domain** | 9 | Domain CRUD, DNS validation, Traefik.me generation |
  299. | **Environment** | 7 | Multi-environment support per project |
  300. | **Deployment** | 8 | Deployment history, queue management, centralized view |
  301. ### Databases
  302. | Category | Tools | Description |
  303. |----------|-------|-------------|
  304. | **PostgreSQL** | 15 | Full lifecycle — create, deploy, start, stop, rebuild, passwords, external ports, environment |
  305. | **MySQL** | 15 | Full lifecycle — create, deploy, start, stop, rebuild, passwords, external ports, environment |
  306. | **MariaDB** | 15 | Full lifecycle — create, deploy, start, stop, rebuild, passwords, external ports, environment |
  307. | **MongoDB** | 15 | Full lifecycle — create, deploy, start, stop, rebuild, passwords, external ports, environment |
  308. | **Redis** | 15 | Full lifecycle — create, deploy, start, stop, rebuild, passwords, external ports, environment |
  309. | **LibSQL** | 13 | Full lifecycle — create, deploy, start, stop, rebuild, external ports, environment |
  310. ### Infrastructure
  311. | Category | Tools | Description |
  312. |----------|-------|-------------|
  313. | **Server** | 17 | Multi-server management, metrics, security, monitoring setup |
  314. | **Docker** | 9 | Container management — list, restart, remove, upload files, inspect config |
  315. | **Cluster / Swarm** | 8 | Swarm node management, container stats, cluster operations |
  316. | **Settings** | 51 | Server settings, Traefik config, Docker cleanup, GPU, monitoring, Redis, disk usage |
  317. | **Registry** | 7 | Docker registry management and testing |
  318. ### Security & Auth
  319. | Category | Tools | Description |
  320. |----------|-------|-------------|
  321. | **SSO** | 10 | Single sign-on providers, trusted origins |
  322. | **SSH Keys** | 7 | SSH key management — create, generate, list, update, remove |
  323. | **Certificates** | 5 | SSL/TLS certificate management |
  324. | **Security** | 4 | Basic auth and security rules per application |
  325. | **Custom Roles** | 6 | Role-based access control with custom permissions |
  326. | **User** | 23 | User management, permissions, API keys, invitations, metrics |
  327. | **Organization** | 11 | Multi-org support, invitations, member roles |
  328. ### Operations
  329. | Category | Tools | Description |
  330. |----------|-------|-------------|
  331. | **Backup** | 12 | Database backups — Postgres, MySQL, MariaDB, MongoDB, LibSQL, Compose, WebServer |
  332. | **Volume Backups** | 6 | Volume-level backup scheduling and management |
  333. | **Destination** | 6 | S3-compatible backup destinations (AWS, Cloudflare R2, etc.) |
  334. | **Schedule** | 6 | Scheduled tasks — cron-based automation |
  335. | **Notification** | 41 | Multi-channel alerts — Slack, Discord, Telegram, Email, Teams, Gotify, Ntfy, Pushover, Lark, Mattermost, Resend, Custom webhooks |
  336. | **Rollback** | 2 | Application rollback management |
  337. ### Other
  338. | Category | Tools | Description |
  339. |----------|-------|-------------|
  340. | **AI** | 9 | AI-powered suggestions, model management |
  341. | **Git Providers** | 27 | GitHub, GitLab, Gitea, Bitbucket — branches, repos, connection testing |
  342. | **Tag** | 8 | Project tagging and bulk assignment |
  343. | **Patch** | 12 | File patching system for applications |
  344. | **Mounts** | 6 | Volume and bind mount management |
  345. | **Port** | 4 | Port mapping configuration |
  346. | **Redirects** | 4 | URL redirect rules |
  347. | **Preview Deployments** | 4 | PR preview deployment management |
  348. | **Stripe** | 7 | Billing and subscription management |
  349. | **License Key** | 6 | Enterprise license management |
  350. | **Whitelabeling** | 4 | Custom branding for enterprise |
  351. | **Audit Log** | 1 | Activity audit trail |
  352. | **Admin** | 1 | Admin-level monitoring setup |
  353. ### Tool Filtering
  354. By default, the server exposes all Dokploy API tools. Some MCP clients and LLM providers can be slower or less reliable when very large tool lists are sent to the model. You can reduce the loaded tools with presets or tag filters.
  355. Use `DOKPLOY_TOOL_PRESET` for common workflows:
  356. | Preset | Included tags |
  357. |--------|---------------|
  358. | `all` | All tools (default) |
  359. | `minimal` | `project`, `application` |
  360. | `core` | `project`, `server`, `application` |
  361. | `deploy` | `project`, `environment`, `server`, `application`, `compose`, `domain`, `deployment` |
  362. | `databases` | `postgres`, `redis`, `mysql`, `mariadb`, `mongo`, `libsql` |
  363. | `git` | `github`, `gitlab`, `bitbucket`, `gitea`, `gitProvider`, `registry`, `sshKey` |
  364. ```bash
  365. # Recommended starting point for clients/providers sensitive to large toolsets
  366. DOKPLOY_TOOL_PRESET=minimal
  367. ```
  368. For exact control, set `DOKPLOY_ENABLED_TAGS`:
  369. ```bash
  370. # Only load project, application, and postgres tools
  371. DOKPLOY_ENABLED_TAGS=project,application,postgres
  372. ```
  373. You can also remove categories from a preset:
  374. ```bash
  375. DOKPLOY_TOOL_PRESET=core
  376. DOKPLOY_DISABLED_TAGS=postgres,redis
  377. ```
  378. If `DOKPLOY_ENABLED_TAGS` is set, it takes precedence over `DOKPLOY_TOOL_PRESET`. `DOKPLOY_DISABLED_TAGS` is applied last.
  379. All tools include semantic annotations (`readOnlyHint`, `destructiveHint`, `idempotentHint`) to help MCP clients understand their behavior and safety characteristics.
  380. ## Architecture
  381. Built with **@modelcontextprotocol/sdk**, **TypeScript**, and **Zod** for type-safe schema validation:
  382. - **508 Tools** covering the entire Dokploy API
  383. - **Multiple Transports**: Stdio (default) and HTTP (Streamable HTTP + legacy SSE)
  384. - **Auto-generated Tools**: Tools are generated from the Dokploy OpenAPI spec via `pnpm generate:all`
  385. - **Tool Filtering**: Load only the categories you need via `DOKPLOY_ENABLED_TAGS`
  386. - **Robust Error Handling**: Centralized API client with interceptors and retry logic
  387. - **Type Safety**: Full TypeScript with Zod schema validation
  388. - **Tool Annotations**: Semantic hints for MCP client behavior understanding
  389. ## Development
  390. Clone the project and install dependencies:
  391. ```bash
  392. git clone https://github.com/Dokploy/mcp.git
  393. cd mcp
  394. pnpm install
  395. ```
  396. Build:
  397. ```bash
  398. pnpm build
  399. ```
  400. Regenerate tools from the Dokploy OpenAPI spec:
  401. ```bash
  402. pnpm generate:all
  403. ```
  404. ### Local Configuration Example
  405. ```json
  406. {
  407. "mcpServers": {
  408. "dokploy-mcp": {
  409. "command": "npx",
  410. "args": ["tsx", "/path/to/mcp/src/index.ts"],
  411. "env": {
  412. "DOKPLOY_URL": "https://your-dokploy-server.com",
  413. "DOKPLOY_API_KEY": "your-dokploy-api-token"
  414. }
  415. }
  416. }
  417. }
  418. ```
  419. ### Testing with MCP Inspector
  420. ```bash
  421. npx -y @modelcontextprotocol/inspector npx @dokploy/mcp
  422. ```
  423. ## Troubleshooting
  424. ### MCP Client Errors
  425. 1. Try adding `@latest` to the package name.
  426. 2. Make sure you are using Node v18 or higher to have native fetch support with `npx`.
  427. 3. Verify your `DOKPLOY_URL` and `DOKPLOY_API_KEY` environment variables are correctly set.
  428. 4. If too many tools are loading or your provider times out while processing tools, start with `DOKPLOY_TOOL_PRESET=minimal`, then use `DOKPLOY_ENABLED_TAGS` for exact category filtering if needed.
  429. ## Contributing
  430. We welcome contributions! If you'd like to contribute to the Dokploy MCP Server, please check out our [Contributing Guide](CONTRIBUTING.md).
  431. ## Support
  432. If you encounter any issues, have questions, or want to suggest a feature, please [open an issue](https://github.com/Dokploy/mcp/issues) in our GitHub repository.
  433. ## License
  434. This project is licensed under the [Apache License](LICENSE).

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.