andradehenrique

@andradehenrique/dokploy-mcp

0 Stars 6 次浏览 andradehenrique 更新于 2026-08-23

MCP 服务配置

复制以下 JSON 到 OPClaw 或其他 MCP 客户端的配置文件中即可使用

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

服务介绍

Dokploy MCP Server

Dokploy MCP Server 通过 Model Context Protocol (MCP) 将 Dokploy 功能作为工具提供。它允许与 MCP 兼容的客户端（例如，AI 模型、其他应用程序）以编程方式与您的 Dokploy 服务器进行交互。

该服务器专注于直接用于 Dokploy API 操作的工具，为项目和应用程序管理提供了简洁高效的接口。

🛠️ 快速开始

要求

Node.js >= v18.0.0（或 Docker）
Cursor、VS Code、Claude Desktop 或其他 MCP 客户端
正在运行的 Dokploy 服务器实例

在 Cursor 中安装

前往：设置 -> Cursor 设置 -> MCP -> 添加新的全局 MCP 服务器

将以下内容添加到您的 Cursor ~/.cursor/mcp.json 文件中。您也可以通过在项目文件夹中创建 .cursor/mcp.json 来在特定项目中安装。有关更多信息，请参阅 Cursor MCP 文档。

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

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

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

在 Windsurf 中安装

将以下内容添加到您的 Windsurf MCP 配置文件中。有关更多信息，请参阅 Windsurf MCP 文档。

在 VS Code 中安装

将以下内容添加到您的 VS Code MCP 配置文件中。有关更多信息，请参阅 VS Code MCP 文档。

json
{
"servers": {
"dokploy-mcp": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@ahdev/dokploy-mcp"],
"env": {
"DOKPLOY_URL": "https://your-dokploy-server.com/api",
"DOKPLOY_AUTH_TOKEN": "your-dokploy-api-token"
}
}
}
}### 在 Zed 中安装

将以下内容添加到您的 Zed settings.json 文件中。有关更多信息，请参阅 Zed Context Server 文档。

json
{
"context_servers": {
"dokploy-mcp": {
"command": {
"path": "npx",
"args": ["-y", "@ahdev/dokploy-mcp"]
},
"settings": {
"DOKPLOY_URL": "https://your-dokploy-server.com/api",
"DOKPLOY_AUTH_TOKEN": "your-dokploy-api-token"
}
}
}
}

在 Claude Desktop 中安装

将以下内容添加到您的 Claude Desktop claude_desktop_config.json 文件中。有关更多信息，请参阅 Claude Desktop MCP 文档。

在 BoltAI 中安装

打开应用程序的“设置”页面，导航到“插件”，并输入以下 JSON：

使用 Docker

如果您希望在 Docker 容器中运行 MCP 服务器：

构建 Docker 镜像：

克隆仓库并构建镜像：

bash
git clone https://github.com/andradehenrique/dokploy-mcp.git
cd dokploy-mcp
docker build -t dokploy-mcp .
配置您的 MCP 客户端：

更新您的 MCP 客户端配置以使用 Docker 命令。

VS Code 示例：

json
{
"servers": {
"dokploy-mcp": {
"type": "stdio",
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"DOKPLOY_URL=https://your-dokploy-server.com/api",
"-e",
"DOKPLOY_AUTH_TOKEN=your-dokploy-api-token",
"dokploy-mcp"
]
}
}
}

Cursor 示例：

json
{
"mcpServers": {
"dokploy-mcp": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"DOKPLOY_URL=https://your-dokploy-server.com/api",
"-e",
"DOKPLOY_AUTH_TOKEN=your-dokploy-api-token",
"dokploy-mcp"
]
}
}
}

Claude Desktop 示例：

json
{
"mcpServers": {
"dokploy-mcp": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"DOKPLOY_URL=https://your-dokploy-server.com/api",
"-e",
"DOKPLOY_AUTH_TOKEN=your-dokploy-api-token",
"dokploy-mcp"
]
}
}
}

在 Windows 上安装

与 Linux 或 macOS 相比，Windows 上的配置略有不同。使用 cmd 作为命令包装器：

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

环境变量

DOKPLOY_URL: 您的 Dokploy 服务器 API URL（必需）
DOKPLOY_AUTH_TOKEN: 您的 Dokploy API 认证令牌（必需）

📚 可用工具

此 MCP 服务器通过 31 个工具 提供了全面的 Dokploy 项目和应用管理工具，这些工具分为两个主要类别：

🗂️ 项目管理（6 个工具）

完整的项目生命周期管理，包括创建、更新、复制和删除：

project-all - 列出所有项目- project-one - 获取项目详情
project-create - 创建新项目
project-update - 更新项目配置
project-duplicate - 复制项目并选择性复制服务
project-remove - 删除项目

🚀 应用管理（25 个工具）

全面的应用生命周期和配置管理：

核心操作

CRUD 操作：创建、读取、更新、删除应用
生命周期管理：部署、重新部署、启动、停止、重新加载应用
实用操作：在项目之间移动、清理队列、刷新令牌

Git 提供商集成

支持多个 Git 提供商，并具有特定配置：

GitHub 提供商 - 完整的 GitHub 集成，包括 Webhook
GitLab 提供商 - 完整的 GitLab 项目集成
Bitbucket 提供商 - Bitbucket 仓库管理
Gitea 提供商 - 自托管 Gitea 集成
Git 提供商 - 自定义 Git 仓库支持
Docker 提供商 - 直接部署 Docker 镜像

配置管理

构建设置 - 配置构建类型（Dockerfile、Heroku、Nixpacks 等）
环境管理 - 环境变量和构建参数
监控集成 - 应用监控和指标
Traefik 配置 - 负载均衡器和反向代理设置

有关每个工具的详细信息，包括输入模式、必填字段和使用示例，请参阅 TOOLS.md。

工具注解

所有工具都包含语义注解，以帮助 MCP 客户端理解其行为：

只读工具 (readOnlyHint: true)：仅检索数据的安全操作
破坏性工具 (destructiveHint: true)：修改或删除资源的操作
创建工具 (destructiveHint: false)：创建新资源的操作
幂等工具 (idempotentHint: true)：可以安全重复执行的操作
外部 API 工具 (openWorldHint: true)：所有工具与 Dokploy API 交互

🏗️ 架构

Dokploy MCP 服务器基于以下技术构建：

@modelcontextprotocol/sdk：用于创建 MCP 服务器并定义工具
Node.js & TypeScript：作为底层运行时和语言
Stdio 传输：通过标准输入/输出 (stdio) 与 MCP 客户端通信
Dokploy API 集成：直接与 Dokploy 服务器的 REST API 交互
全面的工具覆盖：完整实现所有 Dokploy 应用程序和项目端点
强大的错误处理：集中化的 HTTP 客户端，带有重试逻辑和结构化错误响应
模式验证：基于 Zod 的完整输入验证，匹配 OpenAPI 规范
工具注解：语义注解（如 readOnlyHint、destructiveHint 等）以增强 MCP 客户端的理解

服务器架构支持：

31 个工具，涵盖所有项目和应用管理操作
多个 Git 提供商（GitHub、GitLab、Bitbucket、Gitea、自定义 Git）
灵活的配置，适用于构建、部署和监控
类型安全的操作，具有全面的 TypeScript 支持

每个工具都包括输入验证、API 集成和结构化的响应格式，以确保与 MCP 客户端的一致交互。

🔧 开发

克隆项目并安装依赖项：

bash
git clone https://github.com/andradehenrique/dokploy-mcp.git
cd dokploy-mcp
npm install

构建：

bash
npm run build

本地配置示例

json
{
"mcpServers": {
"dokploy-mcp": {
"command": "npx",
"args": ["tsx", "/path/to/dokploy-mcp/src/index.ts"],
"env": {
"DOKPLOY_URL": "https://your-dokploy-server.com/api",
"DOKPLOY_AUTH_TOKEN": "your-dokploy-api-token"
}
}
}
}

使用 MCP Inspector 进行测试

bash
npx -y @modelcontextprotocol/inspector npx @ahdev/dokploy-mcp

文档- TOOLS.md - 完整的工具参考，包含架构和示例

CONTRIBUTING.md - 贡献指南

🔧 故障排除

MCP 客户端错误

尝试在包名后添加 @latest。
确保你使用的是 Node v18 或更高版本，以便 npx 支持原生 fetch。
验证你的 DOKPLOY_URL 和 DOKPLOY_AUTH_TOKEN 环境变量是否正确设置。

🤝 贡献

我们欢迎贡献！如果你想为 Dokploy MCP 服务器做出贡献，请查阅我们的贡献指南。

🆘 支持

如果你遇到任何问题、有疑问或想建议一个功能，请在我们的 GitHub 仓库中打开一个 issue。

📄 许可证

本项目采用 MIT 许可证。

查看源码项目主页