@dokploy/mcp

中文文档
0.30.7发布于 2026/09/18Apache-2.0ES Module近 30 天下载 1.1万

Dokploy API 的 MCP 服务器

中文使用文档
文档目录33 节
  1. 开始
  2. 所需资源
  3. 在光标中安装
  4. 在 Windsurf 安装
  5. 在 VS 代码中安装
  6. 在 Claude 代码中安装
  7. 在 Zed 安装
  8. 在 Claude 桌面中安装
  9. 在 BoltAI 安装
  10. 在 Opencode 中安装
  11. 使用嵌入器
  12. 在 Windows 中安装
  13. 环境变量
  14. 运输模式
  15. Stdio 模式( 默认)
  16. HTTP 模式(可立体 HTTP + 遗留 SSE)
  17. 可用工具( 508)
  18. 核心资源
  19. 数据库
  20. 基础设施
  21. 安全认证( A)
  22. 业务
  23. 其它
  24. 工具过滤
  25. 建筑
  26. 发展
  27. 本地配置示例
  28. 与 MCP 检查员进行测试
  29. 解决问题
  30. MCP 客户端错误
  31. 捐款
  32. 支助
  33. 许可证

Dokploy MCP 服务器

npm version Install in VS Code (npx)

Dokploy MCP 软件 服务器曝光 所有 Dokploy API 端点 通过《环境协议范本》作为消耗性工具。 它允许MCP兼容客户端(例如AI模型,其他应用程序)在程序上与你的多克普勒服务器交互.

与 508个工具 纵横 49个职类,这个服务器提供了Dokploy API的完整覆盖——从项目和应用管理到数据库,通知,SSO,多克,备份等等.

开始

所需资源

  • 节点.js QQv 18.0.0(或多克克)
  • 光标、 VS 代码、 Claude 桌面或 MCP 客户端
  • 运行中的 Dokploy 服务器实例

在光标中安装

转到 : Settings - > (中文) Cursor Settings - > (中文) MCP - > (中文) Add new global MCP server

将此添加到您的光标 ~/.cursor/mcp.json 文档。 您也可以通过创建 .cursor/mcp.json 在您的工程文件夹中。 见 光标 MCP 文件 需要更多信息.

{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "npx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}
替代品: 使用包
{
  "mcpServers": {
    "dokploy-mcp": {
      "command": "bunx",
      "args": ["-y", "@dokploy/mcp"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      }
    }
  }
}
替代品: 使用Deno
{
  "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"
      }
    }
  }
}

在 Windsurf 安装

将此添加到您的 Windsurf MCP 配置文件 。 见 Windsurf MCP 文件 需要更多信息.

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

在 VS 代码中安装

Install in VS Code (npx) Install in VS Code Insiders (npx)

将此添加到您的 VS 代码 MCP 配置文件中 。 见 VS 代码 MCP 文件 需要更多信息.

{
  "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"
      }
    }
  }
}

在 Claude 代码中安装

用 CLI 将 MCP 服务器添加到 Claude Code 中 :

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

然后将环境变量设置在您的 .claude/settings.json 或用内线通过 :

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

在 Zed 安装

将此添加到您的 Zed settings.json。见 Zed 上下文服务器文件 需要更多信息.

{
  "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"
      }
    }
  }
}

在 Claude 桌面中安装

将此添加到您的 Claude 桌面 claude_desktop_config.json 文档。 见 Claude 桌面 MCP 文件 需要更多信息.

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

在 BoltAI 安装

打开应用的"设置"一页,导航到"Plugins",并输入以下JSON:

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

在 Opencode 中安装

将此添加到您的 OpenCode 配置中( 默认位置为 ~/. config/ opencode/ opencode. json 或 opencode. json 为本地/ 项目配置) 。 见 打开代码 MCP 配置 需要更多信息.

{
  "mcp": {
    "dokploy": {
      "type": "local",
      "command": ["npx", "-y", "@dokploy/mcp"],
      "environment": {
        "DOKPLOY_URL": "https://your-dokploy-server.com",
        "DOKPLOY_API_KEY": "your-dokploy-api-token"
      },
      "enabled": true
    }
  }
}

使用嵌入器

Docker 容器支持两者 静态 财务报告和审定财务报表 HTTP 密码 运输模式,使其对不同的部署情景具有灵活性.

  1. 构建多克图像 :

    git clone https://github.com/Dokploy/mcp.git
    cd mcp
    docker build -t dokploy-mcp .
    
  2. 手动嵌入命令 :

    Stdio 模式( MCP 客户端):

    docker run -it --rm \
      -e DOKPLOY_URL=https://your-dokploy-server.com \
      -e DOKPLOY_API_KEY=your_token_here \
      dokploy-mcp
    

    HTTP 模式( 用于网络应用) :

    docker run -it --rm \
      -p 8080:3000 \
      -e MCP_TRANSPORT=http \
      -e DOKPLOY_URL=https://your-dokploy-server.com \
      -e DOKPLOY_API_KEY=your_token_here \
      dokploy-mcp
    
  3. 多克编曲 :

    使用提供的 docker-compose.yml 用于生产部署:

    # Start HTTP service
    docker-compose up -d dokploy-mcp-http
    
    # View logs
    docker-compose logs -f dokploy-mcp-http
    
  4. MCP 客户端配置 :

    对于stdio模式(Claude桌面、VS代码等):

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

    HTTP 模式( 网络应用) :

    先启动 HTTP 服务器,然后配置您的客户端以连接到 http://localhost:3000/mcp。 。 。 .

在 Windows 中安装

与Linux或macOS相比,Windows上的配置略有不同. 使用 cmd 作为命令包线 :

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

环境变量

变量需求说明
DOKPLOY_URL对您的 Dokploy 服务器 URL( 例如 ), https://your-dokploy-server.com(中文(简体) )
DOKPLOY_API_KEY对您的 Dokploy API 认证符
DOKPLOY_CUSTOM_HEADERS没有JSON 附加上游请求头的对象 。 标题名称和值必须是字符串 。 无法在此设置保留信头 : x-api-key, (中文(简体) ), content-type, (中文(简体) ), accept。 。 。 .
DOKPLOY_TOOL_PRESET没有装入的预定义工具集 : all (违约), minimal, (中文(简体) ), core, (中文(简体) ), deploy, (中文(简体) ), databases,或 git用于与非常大的工具清单相搏的客户/提供者.
DOKPLOY_ENABLED_TAGS没有逗号分隔的要过滤哪些工具被装入的标签列表(例如, project,application,postgres(中文(简体) )
DOKPLOY_DISABLED_TAGS没有以逗号分隔的标签列表来排除选中的工具集 。 之后应用 DOKPLOY_TOOL_PRESET 或者说 DOKPLOY_ENABLED_TAGS。 。 。 .
DOKPLOY_TIMEOUT没有请求超时以毫秒计( 默认 ): 30000(中文(简体) )
DOKPLOY_RETRY_ATTEMPTS没有尝试重试的次数( 默认 ): 3(中文(简体) )
DOKPLOY_RETRY_DELAY没有重试之间以毫秒为单位的延迟( 默认 ): 1000(中文(简体) )
DOKPLOY_REDACT_ENV没有从 API 回复到 MCP 客户端( 默认 ) 之前, 编辑包含秘密字段( env vars, 作曲文件, 密码, 令牌, 密钥) : true) (中文(简体) ). 设定为 false 只有您在 LLM 上下文中明确需要原始的秘密值.
DOKPLOY_REDACT_FIELDS没有逗号分隔的响应字段名称列表以编辑 DOKPLOY_REDACT_ENV=true在任何筑巢深度都匹配不敏感大小写。 默认为: 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。 。 。 .

对于Cloudflare Access 或类似倒置代理机背后的 Dokploy 实例,通过带有这样的占位符值的服务键头:

DOKPLOY_CUSTOM_HEADERS='{"CF-Access-Client-Id":"your-client-id.access","CF-Access-Client-Secret":"your-client-secret"}'

运输模式

这个 MCP 服务器支持多个传输模式来适应不同的使用大小写 :

Stdio 模式( 默认)

默认模式使用stdio进行直接进程通信,理想的桌面应用程序和命令行使用.

# Run with stdio (default)
npx -y @dokploy/mcp

HTTP 模式(可立体 HTTP + 遗留 SSE)

现代 HTTP 模式通过 HTTP/ HTTPS 支持显示服务器 现代和遗留协议 最大兼容性 :

  • 可流式HTTP(MCP 2025-03-26) - 有会议管理的现代协议
  • 遗产SSE(MCP 2024-11-05) - 对老客户的后向兼容性
# Run with HTTP mode
npx -y @dokploy/mcp --http
# or via environment variable
MCP_TRANSPORT=http npx -y @dokploy/mcp

现代可流 HTTP 端点 :

终点方法说明
/mcp邮政客户端到服务器的请求
/mcp获取服务器对客户通知(SSE)
/mcp迪莱特会话终止
/health获取健康检查

遗产 SSE 终点( Backwards 兼容性) :

终点方法说明
/sse获取SSE 流初始化
/messages邮政客户端消息张贴

可用工具( 508)

这个 MCP 服务器提供 508个工具 覆盖整个Dokploy API,组织成 49个职类数字 :

核心资源

类别工具说明
项目第8条创建、列表、更新、复制、搜索和删除工程
应用30个完整的应用程序生命周期——创建,部署,重新部署,启动,停止,构建类型,提供git(GitHub,GitLab,Bitbucket,Gitea),环境,Traefik配置
编曲29个Docker 编译管理——创建,部署,模板,服务,环境,孤立部署
域名第9条域名 CRUD, DNS 验证, Traefik. me 生成
环境第7条每个项目的多环境支助
部署第8条部署历史、队列管理、集中视图

数据库

类别工具说明
邮递SQL15个全生命周期——创建,部署,启动,停止,重建,密码,外部端口,环境
MySQL 数据15个全生命周期——创建,部署,启动,停止,重建,密码,外部端口,环境
马里亚DB15个全生命周期——创建,部署,启动,停止,重建,密码,外部端口,环境
蒙戈DB15个全生命周期——创建,部署,启动,停止,重建,密码,外部端口,环境
重写15个全生命周期——创建,部署,启动,停止,重建,密码,外部端口,环境
立方块QL第13条整个生命周期——创建,部署,启动,停止,重建,外部港口,环境

基础设施

类别工具说明
服务器页:1多服务器管理、计量、安全、监测设置
夹克第9条容器管理——列表,重新启动,删除,上传文件,检查配置
集群/ 沼泽第8条沼泽节点管理、集装箱统计、集群业务
设置51国服务器设置、 Trafik 配置、 Docker 清理、 GPU、 监视、 Redis、 磁盘使用
书记官处第7条Docker 注册管理和测试

安全认证( A)

类别工具说明
所罗门群岛10个单一签名提供者, 可信来源
SSH 密钥第7条SSH 密钥管理 - 创建,生成,列表,更新,去除
证书页:1SSL/TLS 证书管理
警卫页:1每项申请的基本认证和安全规则
自定义角色6个基于角色的自定义访问控制
用户第23条用户管理、权限、 API 密钥、 邀请、 度量衡
组织第11个多组支助、邀请、成员作用

业务

类别工具说明
备份第12条数据库备份 — Postgres, MySQL, MariaDB, MongoDB, LibSQL, 编译, WebServer
音量备份6个量级备份安排和管理
目标6个S3兼容备份目的地(AWS, Cloudflare R2等)
时间表6个排定的任务——基于编组的自动化
通知第41条多频道提醒 — Slack, Discord, Telegram, 电子邮件, Teams, Gotify, Ntfy, Pushover, Lark, Matterm, Resend, C自定义网络呼号
回滚2个应用程序回滚管理

其它

类别工具说明
大赦国际第9条AI强势建议、模式管理
Git 供应商27个GitHub, GitLab, Gitea, Bitbucket - 分支, repos, 连接测试
标记第8条项目标记和批量分配
补丁第12条应用程序的文件补丁系统
挂载6个量和装载管理
端口页:1端口映射配置
重定向页:1URL 重定向规则
预览部署页:1PR 预览部署管理
条纹第7条账单和订阅管理
许可证密钥6个企业许可证管理
白标签页:1企业定制品牌
审计日志1个活动审计线索
管理员1个行政一级监测机构

工具过滤

默认情况下,服务器会曝光所有多克普洛伊API工具. 一些MCP客户端和LLM提供商在向模型发送非常大的工具列表时可以比较慢或不太可靠. 可以用预设或标签过滤器来减少已装入的工具.

使用 DOKPLOY_TOOL_PRESET 用于共同工作流程:

预设包含标签
all所有工具( 默认)
minimalproject, (中文(简体) ), application
coreproject, (中文(简体) ), server, (中文(简体) ), application
deployproject, (中文(简体) ), environment, (中文(简体) ), server, (中文(简体) ), application, (中文(简体) ), compose, (中文(简体) ), domain, (中文(简体) ), deployment
databasespostgres, (中文(简体) ), redis, (中文(简体) ), mysql, (中文(简体) ), mariadb, (中文(简体) ), mongo, (中文(简体) ), libsql
gitgithub, (中文(简体) ), gitlab, (中文(简体) ), bitbucket, (中文(简体) ), gitea, (中文(简体) ), gitProvider, (中文(简体) ), registry, (中文(简体) ), sshKey
# Recommended starting point for clients/providers sensitive to large toolsets
DOKPLOY_TOOL_PRESET=minimal

对于精确控制,设定 DOKPLOY_ENABLED_TAGS数字 :

# Only load project, application, and postgres tools
DOKPLOY_ENABLED_TAGS=project,application,postgres

也可以从预设中删除分类 :

DOKPLOY_TOOL_PRESET=core
DOKPLOY_DISABLED_TAGS=postgres,redis

若为 DOKPLOY_ENABLED_TAGS 设定,它优先于 DOKPLOY_TOOL_PRESET。 。 。 . DOKPLOY_DISABLED_TAGS 最后应用.

所有工具都包括语义说明(readOnlyHint, (中文(简体) ), destructiveHint, (中文(简体) ), idempotentHint)帮助MCP客户了解他们的行为和安全特征.

建筑

与 @ modelcontextprotocol/ sdk (英语), (中文(简体) ), 类型脚本,以及 佐德语Name 用于类型安全计划验证:

  • 508 工具 覆盖整个 Dokploy API
  • 多重运输: Stdio (默认)和 HTTP (Streamable HTTP + 遗留的SSE)
  • 自动生成的工具: 工具由 Dokploy OpenAPI 光谱通过生成 pnpm generate:all
  • 工具过滤: 仅装入所需类别 DOKPLOY_ENABLED_TAGS
  • 强力错误处理: 集中了 API 客户端并带有截取器和重试逻辑
  • 类型安全: 带有 Zod schema 验证的完整类型脚本
  • 工具说明: MCP 客户端行为理解语义提示

发展

清除工程并安装依赖性 :

git clone https://github.com/Dokploy/mcp.git
cd mcp
pnpm install

构建 :

pnpm build

从 Dokploy OpenAPI 光谱重生工具 :

pnpm generate:all

本地配置示例

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

与 MCP 检查员进行测试

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

解决问题

MCP 客户端错误

  1. 尝试添加 @latest 转到软件包名称.

  2. 请确定您正在使用Node v18 或更高端的本地获取支持 npx。 。 。 .

  3. 检查您 DOKPLOY_URL 财务报告和审定财务报表 DOKPLOY_API_KEY 环境变量设置正确.

  4. 如果处理工具时有太多工具在装入, 或是您的提供者出厂, 请从 DOKPLOY_TOOL_PRESET=minimal,然后使用 DOKPLOY_ENABLED_TAGS 用于在必要时进行精确分类过滤.

捐款

我们欢迎捐款! 请检查access-date=中的日期值 (帮助) 贡献指南。 。 。 .

支助

如果你遇到任何问题,有问题,或者想提出一个特征,请 打开一个问题 在我们的 GitHub 仓库中.

许可证

本项目根据以下规定获得许可证: Apache 许可证。 。 。 .

版本与发布记录

@dokploy/mcp 共发布 25 个版本,首次发布于 2026/04/16;过去 12 个月发布了 25 个版本。

版本发布日期距今
0.30.7latest2026/09/181 个月前
0.30.62026/09/092 个月前
0.30.52026/09/022 个月前
0.30.42026/09/022 个月前
0.30.32026/08/312 个月前
0.30.22026/08/192 个月前

关于 @dokploy/mcp 的常见问题

@dokploy/mcp 是什么?

Dokploy API 的 MCP 服务器

如何安装 @dokploy/mcp?

在项目目录运行 npm install @dokploy/mcp,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 dokploy-mcp,可以用 npx dokploy-mcp 直接运行。

@dokploy/mcp 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/dokploy__mcp 是否存在。

@dokploy/mcp 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@dokploy/mcp 可以商用吗?

@dokploy/mcp 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@dokploy/mcp 的下载量有多少?

根据 npm 官方下载统计,@dokploy/mcp 在 2026/10/13 – 2026/11/11 这 30 天内被下载 10,684 次,日均约 356 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@dokploy/mcp 还在维护吗?

最新版本 0.30.7 发布于 2026/09/18(1 个月前);至今共发布 25 个版本,其中过去 12 个月发布了 25 个;首次发布于 2026/04/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。