项目简介

Dokploy MCP 服务器是一个应用后端，它通过 Model Context Protocol (MCP) 协议，将 Dokploy 部署平台的管理功能（如项目、应用、数据库管理）暴露为结构化的工具，使得兼容 MCP 的大型语言模型（LLM）客户端能够直接调用这些功能，实现通过 AI 助理管理 Dokploy 部署。

主要功能点

该服务器专注于提供 Dokploy API 的工具访问能力，主要包括：

• 项目管理: 支持列出所有项目、获取特定项目详情、创建新项目、更新项目配置、复制项目以及删除项目。
• 应用管理: 提供全面的应用生命周期管理工具，如创建、读取、更新、删除应用，部署、重新部署、启动、停止、重载应用，以及配置 Git 提供商（GitHub, GitLab, Bitbucket, Gitea, Custom Git, Docker）、构建设置、环境变量、监控和 Traefik 设置等。
• PostgreSQL 数据库管理: 允许创建、读取、更新、删除 PostgreSQL 数据库，部署、启动、停止、重载、重建数据库，以及配置外部端口、环境变量和状态更改等。

这些功能以工具的形式提供，可被 MCP 客户端发现并调用。

安装步骤

1. 确保您已安装 Node.js (v18.0.0 或更高版本) 或 Docker。
2. 确保您有一个正在运行的 Dokploy 服务器实例。
3. 该服务器通常作为 Node.js 包通过 'npx' 运行，或者作为 Docker 容器运行。您无需单独“安装”到系统中，而是在您的 MCP 客户端（如 Cursor, VS Code, Claude Desktop, Zed 等）中进行配置，告诉客户端如何启动该服务器进程。

服务器配置 (在 MCP 客户端中)

配置 Dokploy MCP 服务器是在您的 MCP 客户端应用的设置中完成的。您需要提供客户端用于启动服务器进程的命令和必要参数。配置通常是一个 JSON 片段，包含服务器的名称、启动命令、参数以及必要的环境变量（用于连接到您的 Dokploy 服务器）。

以下是配置所需关键信息的说明：

• 'name': 服务器的标识名称，例如 "dokploy-mcp"。
• 'command': 客户端用来启动服务器的可执行文件路径。通常是 'npx' 或 'docker'。
• 'args': 传递给 'command' 的参数列表。
  • 如果使用 'npx'，参数通常是 '["-y", "@ahdev/dokploy-mcp"]'。
  • 如果使用 'docker'，参数会包含 'run', '-i', '--rm' 以及挂载环境变量的参数。
• 'env': 必需的环境变量，包含：
  • 'DOKPLOY_URL': 您的 Dokploy 服务器 API 的完整 URL (例如: 'https://your-dokploy-server.com/api')。
  • 'DOKPLOY_API_KEY': 用于认证您的 Dokploy API 的令牌。

请查阅您的具体 MCP 客户端的文档，了解如何在其中添加新的 MCP 服务器配置。例如，在 VS Code 中，您可能需要在其 MCP 设置中添加一个服务器条目，指定 'type: "stdio"'。

基本使用方法

一旦在您的 MCP 客户端中配置并成功连接 Dokploy MCP 服务器：

1. 您的 AI 助手或模型将能够发现并了解 Dokploy MCP 服务器提供的工具（例如 'project-create', 'application-deploy', 'postgres-one' 等）。
2. 当您向 AI 提出与 Dokploy 管理相关的请求时（例如“创建一个名为 'my-web-app' 的新应用”），AI 会识别出需要调用 Dokploy MCP 服务器上的相应工具。
3. AI 会根据您的请求构建工具调用所需的输入参数，并发送给 MCP 服务器。
4. MCP 服务器接收到工具调用请求后，会使用提供的 'DOKPLOY_URL' 和 'DOKPLOY_API_KEY' 调用 Dokploy 服务器的实际 API 执行操作。
5. 操作完成后，MCP 服务器会将结果（成功消息、数据或错误信息）格式化为 MCP 响应，发送回客户端。
6. AI 会接收并解释这些响应，然后以自然语言形式回复您，告知操作结果。

通过这种方式，您可以通过与 AI 对话来管理您的 Dokploy 部署。