{"_id":"nd-dokploy-mcp","_rev":"2-c30f38c39eccba2005c7585c60220609","name":"nd-dokploy-mcp","dist-tags":{"latest":"1.6.1"},"versions":{"1.6.0":{"name":"nd-dokploy-mcp","version":"1.6.0","keywords":["modelcontextprotocol","mcp","dokploy"],"author":{"name":"Henrique Andrade","email":"developer@henriqueandrade.dev"},"license":"Apache-2.0","_id":"nd-dokploy-mcp@1.6.0","maintainers":[{"name":"henkey","email":"noonou7@gmail.com"}],"homepage":"https://github.com/Dokploy/mcp#readme","bugs":{"url":"https://github.com/Dokploy/mcp/issues"},"bin":{"dokploy-mcp":"build/index.js"},"dist":{"shasum":"9276188b663f53f4eed0b2769023bcb2016f5c06","tarball":"https://registry.npmjs.org/nd-dokploy-mcp/-/nd-dokploy-mcp-1.6.0.tgz","fileCount":92,"integrity":"sha512-0RgmJbQ/WVRfzyzDgoTRzEL9N/oK06jNDVtsvUGHzwLrzLLN3MFT718GtC+i8LflgRxJCSh5PVsb8o7C44Q8kA==","signatures":[{"sig":"MEYCIQDMGGGXzQvwMAHGV6Y3tbPz6EDxW59SXxXubuvuYvB1GgIhAMtphg2JzTn5+bDGh+L+lbW8f+LoBJTxJNpfvFWvv5KL","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":191623},"main":"build/index.js","type":"module","gitHead":"1d2e8d93397e3556dc9d251b7394629b3aa14f64","scripts":{"dev":"tsc --watch","lint":"eslint src/**/*.ts","test":"echo \"Error: no test specified\" && exit 1","build":"bun run clean && tsc","clean":"rm -rf build || rmdir /s /q build","format":"prettier --write src/**/*.{ts,js,json}","dev:sse":"bun run build && bun run start:sse","dev:http":"bun run build && bun run start:http","lint:fix":"eslint src/**/*.ts --fix","precommit":"bun run lint && bun run format:check && bun run type-check","start:sse":"node build/index.js --sse","start:http":"node build/index.js --http","type-check":"tsc --noEmit","start:stdio":"node build/index.js","format:check":"prettier --check src/**/*.{ts,js,json}"},"_npmUser":{"name":"henkey","email":"noonou7@gmail.com"},"repository":{"url":"git+https://github.com/Dokploy/mcp.git","type":"git"},"_npmVersion":"11.6.0","description":"MCP Server for Dokploy API","directories":{},"_nodeVersion":"24.9.0","dependencies":{"zod":"^3.25.28","axios":"^1.9.0","express":"^5.1.0","@modelcontextprotocol/sdk":"^1.12.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^9.27.0","prettier":"^3.5.3","typescript":"^5.8.3","@types/node":"^22.15.21","@types/eslint":"^9.6.1","@types/express":"^5.0.2","eslint-config-prettier":"^10.1.5","eslint-plugin-prettier":"^5.4.1","@typescript-eslint/parser":"^8.32.1","@typescript-eslint/eslint-plugin":"^8.32.1"},"_npmOperationalInternal":{"tmp":"tmp/nd-dokploy-mcp_1.6.0_1762293061047_0.4821293166610545","host":"s3://npm-registry-packages-npm-production"}},"1.6.1":{"name":"nd-dokploy-mcp","version":"1.6.1","description":"MCP Server for Dokploy API","main":"build/index.js","bin":{"dokploy-mcp":"build/index.js"},"scripts":{"build":"bun run clean && tsc","dev":"tsc --watch","start:stdio":"node build/index.js","start:http":"node build/index.js --http","start:sse":"node build/index.js --sse","dev:http":"bun run build && bun run start:http","dev:sse":"bun run build && bun run start:sse","lint":"eslint src/**/*.ts","lint:fix":"eslint src/**/*.ts --fix","format":"prettier --write src/**/*.{ts,js,json}","format:check":"prettier --check src/**/*.{ts,js,json}","type-check":"tsc --noEmit","clean":"rm -rf build || rmdir /s /q build","precommit":"bun run lint && bun run format:check && bun run type-check","test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/Dokploy/mcp.git"},"keywords":["modelcontextprotocol","mcp","dokploy"],"author":{"name":"Henrique Andrade","email":"developer@henriqueandrade.dev"},"bugs":{"url":"https://github.com/Dokploy/mcp/issues"},"homepage":"https://github.com/Dokploy/mcp#readme","license":"Apache-2.0","type":"module","dependencies":{"@modelcontextprotocol/sdk":"^1.12.0","axios":"^1.9.0","express":"^5.1.0","zod":"^3.25.28"},"devDependencies":{"@types/eslint":"^9.6.1","@types/express":"^5.0.2","@types/node":"^22.15.21","@typescript-eslint/eslint-plugin":"^8.32.1","@typescript-eslint/parser":"^8.32.1","eslint":"^9.27.0","eslint-config-prettier":"^10.1.5","eslint-plugin-prettier":"^5.4.1","prettier":"^3.5.3","typescript":"^5.8.3"},"_id":"nd-dokploy-mcp@1.6.1","gitHead":"cd030973605aa5cad8821233bd398bba57b2130e","_nodeVersion":"24.9.0","_npmVersion":"11.6.0","dist":{"integrity":"sha512-63l5+RG8NUW0hiztokVarjGaI6K/1bWtXX3X04fSTbbXo8qCT+xwLOCdWOUkoxc+bjjTi5DSlITru/4SgEcl1A==","shasum":"66f152d14b16436aa3ebd5cdfd3ec579f965d52e","tarball":"https://registry.npmjs.org/nd-dokploy-mcp/-/nd-dokploy-mcp-1.6.1.tgz","fileCount":92,"unpackedSize":198989,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIFv0DQlwSzXPBXi1aYW8bj2ZFbRDUayuLEasXe6owJExAiBnea4OpoItscaoeLVUVFPkRbZEQ8RmSmdCsuwjAKvH5w=="}]},"_npmUser":{"name":"henkey","email":"noonou7@gmail.com"},"directories":{},"maintainers":[{"name":"henkey","email":"noonou7@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/nd-dokploy-mcp_1.6.1_1762360272033_0.03438506035629474"},"_hasShrinkwrap":false}},"time":{"created":"2025-11-04T21:51:01.046Z","modified":"2025-11-05T16:31:12.412Z","1.6.0":"2025-11-04T21:51:01.268Z","1.6.1":"2025-11-05T16:31:12.229Z"},"bugs":{"url":"https://github.com/Dokploy/mcp/issues"},"author":{"name":"Henrique Andrade","email":"developer@henriqueandrade.dev"},"license":"Apache-2.0","homepage":"https://github.com/Dokploy/mcp#readme","keywords":["modelcontextprotocol","mcp","dokploy"],"repository":{"type":"git","url":"git+https://github.com/Dokploy/mcp.git"},"description":"MCP Server for Dokploy API","maintainers":[{"name":"henkey","email":"noonou7@gmail.com"}],"readme":"# Dokploy MCP Server\r\n\r\n[![npm version](https://img.shields.io/npm/v/nd-dokploy-mcp.svg)](https://www.npmjs.com/package/nd-dokploy-mcp) [<img alt=\"Install in VS Code (bun)\" 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%22bunx%22%2C%22args%22%3A%5B%22-y%22%2C%22nd-dokploy-mcp%40latest%22%5D%7D)\r\n\r\nDokploy MCP Server exposes Dokploy functionalities 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.\r\n\r\nThis server features a **consolidated architecture** with only **4 powerful tools** that cover all 67+ Dokploy API operations, providing a clean and efficient interface for infrastructure management.\r\n\r\n## ✨ Key Features\r\n\r\n- **🚀 Consolidated Architecture**: 4 powerful tools covering all Dokploy operations\r\n- **🔒 Project Locking**: Lock MCP instances to specific projects for multi-tenant setups\r\n- **🎯 Tool Filtering**: Load only the tools you need for specialized MCP instances\r\n- **⚡ Bun Optimized**: Built and optimized for the high-performance Bun runtime\r\n- **🌐 Multi-Transport**: Support for both stdio and HTTP transport modes\r\n\r\n## 🛠️ Getting Started\r\n\r\n### Requirements\r\n\r\n- Node.js >= v18.0.0 (or Docker)\r\n- Cursor, VS Code, Claude Desktop, or another MCP Client\r\n- A running Dokploy server instance\r\n\r\n### Install in Cursor\r\n\r\nGo to: `Settings` -> `Cursor Settings` -> `MCP` -> `Add new global MCP server`\r\n\r\nAdd 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.\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": \"bunx\",\r\n      \"args\": [\"-y\", \"nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n<details>\r\n<summary>Alternative: Use npx</summary>\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": \"npx\",\r\n      \"args\": [\"-y\", \"nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n</details>\r\n\r\n<details>\r\n<summary>Alternative: Use Deno</summary>\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": \"deno\",\r\n      \"args\": [\"run\", \"--allow-env\", \"--allow-net\", \"npm:nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n</details>\r\n\r\n### Install in Windsurf\r\n\r\nAdd this to your Windsurf MCP config file. See [Windsurf MCP docs](https://docs.windsurf.com/windsurf/mcp) for more info.\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": \"bunx\",\r\n      \"args\": [\"-y\", \"nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### Install in VS Code\r\n\r\n[<img alt=\"Install in VS Code (bun)\" 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%22bunx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40ahdev%2Fdokploy-mcp%40latest%22%5D%7D)\r\n[<img alt=\"Install in VS Code Insiders (bun)\" 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%22bunx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40ahdev%2Fdokploy-mcp%40latest%22%5D%7D)\r\n\r\nAdd 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.\r\n\r\n```json\r\n{\r\n  \"servers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": \"bunx\",\r\n      \"args\": [\"-y\", \"nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n<details>\r\n<summary>Alternative: Use npx</summary>\r\n\r\n```json\r\n{\r\n  \"servers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": \"npx\",\r\n      \"args\": [\"-y\", \"nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n</details>\r\n\r\n### Install in Zed\r\n\r\nAdd this to your Zed `settings.json`. See [Zed Context Server docs](https://zed.dev/docs/assistant/context-servers) for more info.\r\n\r\n```json\r\n{\r\n  \"context_servers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": {\r\n        \"path\": \"npx\",\r\n        \"args\": [\"-y\", \"nd-dokploy-mcp\"]\r\n      },\r\n      \"settings\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### Install in Claude Desktop\r\n\r\nAdd this to your Claude Desktop `claude_desktop_config.json` file. See [Claude Desktop MCP docs](https://modelcontextprotocol.io/quickstart/user) for more info.\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": \"bunx\",\r\n      \"args\": [\"-y\", \"nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### Install in BoltAI\r\n\r\nOpen the \"Settings\" page of the app, navigate to \"Plugins,\" and enter the following JSON:\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": \"bunx\",\r\n      \"args\": [\"-y\", \"nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### Using Docker\r\n\r\nThe Docker container supports both **stdio** and **HTTP** transport modes, making it flexible for different deployment scenarios.\r\n\r\n1. **Build the Docker Image:**\r\n\r\n    ```bash\r\n    git clone https://github.com/Dokploy/mcp.git\r\n    cd dokploy-mcp\r\n    docker build -t dokploy-mcp .\r\n    ```\r\n\r\n2. **Manual Docker Commands:**\r\n\r\n    **Stdio Mode (for MCP clients):**\r\n\r\n    ```bash\r\n    docker run -it --rm \\\r\n      -e DOKPLOY_URL=https://your-dokploy-server.com/api \\\r\n      -e DOKPLOY_API_KEY=your_token_here \\\r\n      dokploy-mcp\r\n    ```\r\n\r\n    **HTTP Mode (for web applications):**\r\n\r\n    ```bash\r\n    docker run -it --rm \\\r\n      -p 8080:3000 \\\r\n      -e MCP_TRANSPORT=http \\\r\n      -e DOKPLOY_URL=https://your-dokploy-server.com/api \\\r\n      -e DOKPLOY_API_KEY=your_token_here \\\r\n      dokploy-mcp\r\n    ```\r\n\r\n3. **Docker Compose:**\r\n\r\n    Use the provided `docker-compose.yml` for production deployments:\r\n\r\n    ```bash\r\n    # Start HTTP service\r\n    docker-compose up -d dokploy-mcp-http\r\n\r\n    # View logs\r\n    docker-compose logs -f dokploy-mcp-http\r\n    ```\r\n\r\n4. **MCP Client Configuration:**\r\n\r\n    **For stdio mode (Claude Desktop, VS Code, etc.):**\r\n\r\n    ```json\r\n    {\r\n      \"mcpServers\": {\r\n        \"dokploy-mcp\": {\r\n          \"command\": \"docker\",\r\n          \"args\": [\r\n            \"run\",\r\n            \"-i\",\r\n            \"--rm\",\r\n            \"-e\",\r\n            \"DOKPLOY_URL=https://your-dokploy-server.com/api\",\r\n            \"-e\",\r\n            \"DOKPLOY_API_KEY=your_token_here\",\r\n            \"dokploy-mcp\"\r\n          ]\r\n        }\r\n      }\r\n    }\r\n    ```\r\n\r\n    **For HTTP mode (web applications):**\r\n\r\n    Start the HTTP server first, then configure your client to connect to `http://localhost:3000/mcp`.\r\n\r\n### Install in Windows\r\n\r\nThe configuration on Windows is slightly different compared to Linux or macOS. Use `cmd` as the command wrapper:\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": \"cmd\",\r\n      \"args\": [\"/c\", \"bunx\", \"-y\", \"nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### Environment Variables\r\n\r\n#### Required\r\n\r\n- `DOKPLOY_URL`: Your Dokploy server API URL (required)\r\n- `DOKPLOY_API_KEY`: Your Dokploy API authentication token (required)\r\n\r\n#### Optional - Advanced Configuration\r\n\r\n- `DOKPLOY_ENABLED_TOOLS`: Comma-separated list of consolidated tools to enable (e.g., `dokploy_application,dokploy_postgres`). If not set or empty, all tools will be loaded. Available tools: `dokploy_application`, `dokploy_postgres`, `dokploy_mysql`, `dokploy_project`.\r\n- `DOKPLOY_LOCKED_PROJECT_ID`: Lock the MCP instance to a specific project ID. When set, all operations will be restricted to this project, and the server will validate the project exists on startup. Any attempts to access different projects will be rejected.\r\n\r\n## 🚀 Transport Modes\r\n\r\nThis MCP server supports multiple transport modes to suit different use cases:\r\n\r\n### Stdio Mode (Default)\r\n\r\nThe default mode uses stdio for direct process communication, ideal for desktop applications and command-line usage.\r\n\r\n```bash\r\n# Run with stdio (default)\r\nbunx -y nd-dokploy-mcp\r\n# or\r\nbun run start:stdio\r\n```\r\n\r\n### HTTP Mode (Streamable HTTP + Legacy SSE)\r\n\r\nModern HTTP mode exposes the server via HTTP/HTTPS supporting **both modern and legacy protocols** for maximum compatibility:\r\n\r\n- **Streamable HTTP (MCP 2025-03-26)** - Modern protocol with session management\r\n- **Legacy SSE (MCP 2024-11-05)** - Backwards compatibility for older clients\r\n\r\n```bash\r\n# Run with HTTP mode\r\nbun run start:http\r\n# or\r\nbunx -y nd-dokploy-mcp --http\r\n# or via environment variable\r\nMCP_TRANSPORT=http bunx -y nd-dokploy-mcp\r\n```\r\n\r\n**Modern Streamable HTTP Endpoints:**\r\n\r\n- **POST /mcp** - Client-to-server requests\r\n- **GET /mcp** - Server-to-client notifications\r\n- **DELETE /mcp** - Session termination\r\n- **GET /health** - Health check endpoint\r\n\r\n**Legacy SSE Endpoints (Backwards Compatibility):**\r\n\r\n- **GET /sse** - SSE stream initialization\r\n- **POST /messages** - Client message posting\r\n\r\n**Configuration:**\r\n\r\n- Internal port: `3000` (fixed)\r\n- External port: configurable via `EXTERNAL_PORT` (default: `3000`)\r\n- Supports both modern Streamable HTTP (MCP 2025-03-26) and legacy SSE (MCP 2024-11-05)\r\n- Session management with automatic cleanup for both transport types\r\n\r\n**Client Compatibility:**\r\n\r\nModern clients automatically use the Streamable HTTP endpoints, while legacy clients can connect using the SSE endpoints. The server handles both protocols simultaneously, ensuring compatibility with:\r\n\r\n- **Modern MCP clients** (Claude Desktop, Cline, etc.) → Use `/mcp` endpoints\r\n- **Legacy MCP clients** → Use `/sse` and `/messages` endpoints\r\n- **Custom integrations** → Choose the appropriate protocol for your needs\r\n\r\nFor detailed transport mode documentation and client examples, refer to the configuration examples above.\r\n\r\n## 📚 Available Tools\r\n\r\nThis MCP server provides **4 consolidated tools** that cover all 67+ Dokploy API operations with a clean, unified interface:\r\n\r\n### 🗂️ dokploy_project (6 actions)\r\n\r\n**Project Management Operations:**\r\n\r\n- `list` - List all projects\r\n- `get` - Get specific project details\r\n- `create` - Create new project\r\n- `update` - Update project configuration\r\n- `remove` - Delete project\r\n- `duplicate` - Duplicate project with services\r\n\r\n### 🚀 dokploy_application (35 actions)\r\n\r\n**Application & Domain Management:**\r\n\r\n**Core Application Operations:**\r\n\r\n- `create`, `get`, `update`, `delete`\r\n- `deploy`, `redeploy`, `start`, `stop`, `reload`\r\n- `move`, `markRunning`, `cancelDeployment`, `cleanQueues`\r\n\r\n**Git Provider Integration:**\r\n\r\n- `saveGithubProvider`, `saveGitlabProvider`, `saveBitbucketProvider`\r\n- `saveGiteaProvider`, `saveGitProvider`, `disconnectGitProvider`\r\n\r\n**Configuration Management:**\r\n\r\n- `saveBuildType`, `saveDockerProvider`, `saveEnvironment`\r\n- `readAppMonitoring`, `readTraefikConfig`, `updateTraefikConfig`\r\n- `refreshToken`\r\n\r\n**Domain Management:**\r\n\r\n- `domainCreate`, `domainGet`, `domainUpdate`, `domainDelete`\r\n- `domainByApplicationId`, `domainByComposeId`, `domainGenerateDomain`\r\n- `domainValidate`, `domainCanGenerateTraefikMeDomains`\r\n\r\n### 🐘 dokploy_postgres (13 actions)\r\n\r\n**PostgreSQL Database Management:**\r\n\r\n- `create`, `get`, `update`, `remove`, `move`\r\n- `deploy`, `start`, `stop`, `reload`, `rebuild`\r\n- `changeStatus`, `saveExternalPort`, `saveEnvironment`\r\n\r\n### 🐬 dokploy_mysql (13 actions)\r\n\r\n**MySQL Database Management:**\r\n\r\n- `create`, `get`, `update`, `remove`, `move`\r\n- `deploy`, `start`, `stop`, `reload`, `rebuild`\r\n- `changeStatus`, `saveExternalPort`, `saveEnvironment`\r\n\r\n### 🔧 Tool Architecture\r\n\r\nEach consolidated tool follows this pattern:\r\n\r\n```json\r\n{\r\n  \"tool\": \"dokploy_application\",\r\n  \"action\": \"deploy\",\r\n  \"params\": {\r\n    \"applicationId\": \"app-123\",\r\n    \"title\": \"Production deployment\",\r\n    \"description\": \"Deploying v1.0.0\"\r\n  }\r\n}\r\n```\r\n\r\n**Tool Annotations:**\r\nAll tools include semantic annotations (`destructiveHint`, `idempotentHint`, `openWorldHint`) to help MCP clients understand their behavior and safety characteristics.\r\n\r\nFor detailed schemas, parameters, and usage examples, see **[TOOLS.md](TOOLS.md)**.\r\n\r\n## ⚙️ Advanced Configuration\r\n\r\n### Tool Filtering\r\n\r\nYou can control which tools are loaded by the MCP server using the `DOKPLOY_ENABLED_TOOLS` environment variable. This is useful for creating specialized MCP instances that only handle specific operations.\r\n\r\n**Example: Only load application and PostgreSQL tools**\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": \"npx\",\r\n      \"args\": [\"-y\", \"nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\",\r\n        \"DOKPLOY_ENABLED_TOOLS\": \"dokploy_application,dokploy_postgres\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n**Available consolidated tool names:**\r\n\r\n- `dokploy_application` - Application and domain management\r\n- `dokploy_postgres` - PostgreSQL database management\r\n- `dokploy_mysql` - MySQL database management\r\n- `dokploy_project` - Project management\r\n\r\nIf `DOKPLOY_ENABLED_TOOLS` is not set or is empty, all tools will be loaded.\r\n\r\n### Project Locking\r\n\r\nYou can lock an MCP instance to a specific project using the `DOKPLOY_LOCKED_PROJECT_ID` environment variable. This ensures that all operations are restricted to a single project, providing isolation and security.\r\n\r\n**Example: Lock to a specific project**\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"dokploy-mcp-project-a\": {\r\n      \"command\": \"npx\",\r\n      \"args\": [\"-y\", \"nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\",\r\n        \"DOKPLOY_LOCKED_PROJECT_ID\": \"project-a-id\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n**When project locking is enabled:**\r\n\r\n- The server validates the project exists on startup and fails if the project is not found\r\n- All operations are restricted to the locked project\r\n- Attempts to access different projects are automatically rejected with an error\r\n- Environment IDs are validated to ensure they belong to the locked project\r\n- The `projectId` parameter is automatically injected into operations when not provided\r\n\r\n**Use cases:**\r\n\r\n- **Multi-tenant setups**: Run multiple MCP instances, each locked to a different project/tenant\r\n- **Security**: Prevent accidental operations on wrong projects\r\n- **Isolation**: Create dedicated MCP instances for different teams or environments\r\n\r\n**Combining tool filtering and project locking:**\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"dokploy-mcp-team-backend\": {\r\n      \"command\": \"npx\",\r\n      \"args\": [\"-y\", \"nd-dokploy-mcp\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\",\r\n        \"DOKPLOY_ENABLED_TOOLS\": \"dokploy_application,dokploy_postgres\",\r\n        \"DOKPLOY_LOCKED_PROJECT_ID\": \"backend-project-id\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\nThis configuration creates an MCP instance that only loads application and PostgreSQL tools and restricts all operations to the backend project.\r\n\r\n## 🏗️ Architecture\r\n\r\nBuilt with **@modelcontextprotocol/sdk**, **TypeScript**, and **Zod** for type-safe schema validation:\r\n\r\n- **4 Consolidated Tools** covering all 67+ operations for projects, applications, domains, PostgreSQL, and MySQL\r\n- **Bun Optimized**: High-performance runtime with optimized builds\r\n- **Multiple Transports**: Stdio (default) and HTTP (Streamable HTTP + legacy SSE)\r\n- **Multiple Git Providers**: GitHub, GitLab, Bitbucket, Gitea, custom Git\r\n- **Project Locking**: Built-in isolation for multi-tenant setups\r\n- **Tool Filtering**: Selective loading for specialized MCP instances\r\n- **Robust Error Handling**: Centralized API client with retry logic\r\n- **Type Safety**: Full TypeScript support with Zod schema validation\r\n- **Tool Annotations**: Semantic hints for MCP client behavior understanding\r\n\r\n## 🔧 Development\r\n\r\nClone the project and install dependencies:\r\n\r\n```bash\r\ngit clone https://github.com/Dokploy/mcp.git\r\ncd dokploy-mcp\r\nbun install\r\n```\r\n\r\nBuild:\r\n\r\n```bash\r\nbun run build\r\n```\r\n\r\n### Local Configuration Example\r\n\r\n```json\r\n{\r\n  \"mcpServers\": {\r\n    \"dokploy-mcp\": {\r\n      \"command\": \"bunx\",\r\n      \"args\": [\"tsx\", \"/path/to/dokploy-mcp/src/index.ts\"],\r\n      \"env\": {\r\n        \"DOKPLOY_URL\": \"https://your-dokploy-server.com/api\",\r\n        \"DOKPLOY_API_KEY\": \"your-dokploy-api-token\"\r\n      }\r\n    }\r\n  }\r\n}\r\n```\r\n\r\n### Testing with MCP Inspector\r\n\r\n```bash\r\nnpx -y @modelcontextprotocol/inspector bunx nd-dokploy-mcp\r\n```\r\n\r\n### Documentation\r\n\r\n- **[TOOLS.md](TOOLS.md)** - Complete tool reference with schemas and examples\r\n- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Contributing guidelines\r\n\r\n## 🔧 Troubleshooting\r\n\r\n### MCP Client Errors\r\n\r\n1. Try adding `@latest` to the package name.\r\n\r\n2. Use **Bun** for the best performance: `bunx -y nd-dokploy-mcp@latest`\r\n\r\n3. For Node.js environments: `npx -y nd-dokploy-mcp@latest`\r\n\r\n4. Verify your `DOKPLOY_URL` and `DOKPLOY_API_KEY` environment variables are correctly set.\r\n\r\n5. For consolidated tools, make sure to use the new format:\r\n\r\n   ```json\r\n   {\r\n     \"tool\": \"dokploy_application\",\r\n     \"action\": \"deploy\",\r\n     \"params\": { \"applicationId\": \"your-app-id\" }\r\n   }\r\n   ```\r\n\r\n## 🤝 Contributing\r\n\r\nWe welcome contributions! If you'd like to contribute to the Dokploy MCP Server, please check out our [Contributing Guide](CONTRIBUTING.md).\r\n\r\n## 🆘 Support\r\n\r\nIf 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.\r\n\r\n## 📄 License\r\n\r\nThis project is licensed under the [Apache License](LICENSE).\r\n","readmeFilename":"README.md"}