mcpField
D
Dokploy Mcp

Dokploy Mcp

本地服务
github.com/tacticlaunch云与基础设施654 周前更新

关于 Dokploy Mcp

Dokploy MCP Server 将 Dokploy API 封装为具备类型安全的 MCP 服务,面向管理 Dokploy 部署的用户。它覆盖全部 API 端点,并允许按类别或单项启用工具。

主要功能

  1. 01覆盖 Dokploy API 的 380 个工具
  2. 02默认启用核心工具
  3. 03按需启用或禁用工具
  4. 04基于环境变量进行身份验证
  5. 05自动生成 OpenAPI 类型
  6. 06处理 HTTP 错误

适用场景

  1. 01通过 MCP 客户端管理 Dokploy
  2. 02仅启用所需的工具类别
  3. 03按需调整部署管理工具

MCP 相关

该 MCP 服务将 Dokploy API 操作作为工具提供给 MCP 客户端,并支持运行时控制工具的启用状态。

配置

本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
"mcpServers": {
"dokploy-mcp-tacticlaunch": {
"command": "npx",
"args": [
"-y",
"dokploy-mcp"
],
"env": {
"DOKPLOY_URL": "<DOKPLOY_URL>",
"DOKPLOY_API_KEY": "<DOKPLOY_API_KEY>"
}
}
}
}
启动命令npx -y dokploy-mcp
需要配置的环境变量
DOKPLOY_URL
DOKPLOY_API_KEY密钥

本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。

安装包
npmdokploy-mcp

工具

55

收录的工具列表 · 更新于 3 周前

参数类型必填说明
applicationIdstring是应用程序 ID

详细介绍

Dokploy MCP 服务

功能全面的 Dokploy 模型上下文协议(MCP)服务,可安全地访问完整的 Dokploy API,并通过广泛的工具覆盖所有可用端点。

功能

  • 380 个工具,覆盖 Dokploy API 的 100% 功能
  • 智能工具选择,默认启用核心工具
  • 高级工具可用,但默认禁用以提升性能
  • 类型安全的集成,采用自动生成的 OpenAPI 类型
  • 基于环境变量的身份验证
  • 模块化架构,每个工具都位于单独的文件中
  • 全面的错误处理,涵盖所有 HTTP 状态码
  • 可用于生产环境的 MCP 服务,工具选择经过优化

📋 完整的工具分类和当前状态,请参阅 TOOLS_STATUS.md

安装

npx -y dokploy-mcp

配置

设置以下环境变量:

export DOKPLOY_URL="https://your-dokploy-instance.com"
export DOKPLOY_API_KEY="your-api-key-here"
获取 API 密钥

你可以在 Dokploy 控制面板中创建 API 密钥:

  1. 在 Dokploy 控制面板中前往 设置 → 个人资料
  2. 前往 /dashboard/settings/profile
  3. 生成新的 API 密钥
  4. 复制密钥,并将其用作 DOKPLOY_API_KEY 环境变量

在 Claude Desktop 中使用

添加到 Claude Desktop 配置中:

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

可用工具

如需查看所有可用工具的完整列表、说明和当前状态,请参阅:

📋 TOOLS_STATUS.md - 完整的工具参考,包含状态和管理说明

工具管理

运行时工具控制

你可以使用命令行参数或环境变量,在运行时控制启用或禁用哪些工具:

启用其他工具
# Enable specific tools or categories
npx -y dokploy-mcp --enable-tools postgres/,application-cancelDeployment

# Enable multiple categories
npx -y dokploy-mcp --enable-tools postgres/,mysql/,notification/
禁用特定工具
# Disable specific tools or categories
XMCP_DISABLE_TOOLS=admin/,application-cancelDeployment npx -y dokploy-mcp

# Disable multiple categories
XMCP_DISABLE_TOOLS=admin/,settings/,stripe/ npx -y dokploy-mcp
Claude Desktop 配置
{
  "mcpServers": {
    "dokploy": {
      "command": "npx",
      "args": ["-y", "dokploy-mcp", "--enable-tools", "postgres/,mysql/"],
      "env": {
        "DOKPLOY_URL": "https://your-dokploy-instance.com",
        "DOKPLOY_API_KEY": "your-api-key-here",
        "XMCP_DISABLE_TOOLS": "admin/,stripe/"
      }
    }
  }
}
工具模式
  • 类别模式:postgres/、mysql/、notification/ - 启用或禁用整个类别
  • 特定工具:application-cancelDeployment、server-create - 启用或禁用单个工具
  • 多个模式:用逗号分隔:postgres/,mysql/,application-cancelDeployment
工具类别

有关工具类别及其当前状态的详细信息,请参阅 TOOLS_STATUS.md。

开发模式

若要永久启用其他工具,请修改每个工具元数据中的 disabled 属性:

export const metadata: ToolMetadata = {
  name: 'tool-name',
  description: 'Tool description',
  annotations: {
    title: 'Tool Title',
    destructiveHint: false,
    idempotentHint: true,
  },
  disabled: false, // Set to false to enable, true to disable
}

文档

开发

# Install dependencies
pnpm install

# Build the project (automatically updates TOOLS_STATUS.md)
pnpm build

# Update tools status manually
pnpm run update-tools-status

# Run in development
pnpm dev

许可证

MIT

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。