使用说明
部署MCP服务器
Dokploy 的一个全面模型上下文协议(MCP)服务器,提供对 Dokploy 完整 API 的类型安全访问,并涵盖所有可用端点的广泛工具支持。
特点/特性
- 380种工具 覆盖Dokploy API 100%的功能
- 智能工具选择 核心工具默认启用
- 高级工具 默认情况下可用但为提升性能而禁用
- 类型安全 与自动生成的OpenAPI类型集成
- 基于环境的 认证
- 模块化架构 每个工具分别存储在单独的文件中
- 全面的错误处理 对于所有HTTP状态码
- 已准备好投入生产 配备优化工具选择的MCP服务器
📋 表格或清单 看 TOOLS_STATUS.md 翻译为中文是:“工具状态.md”(其中,“.md”通常表示Markdown格式的文件) 对于完整的工具分解及当前状态
安装
npx -y dokploy-mcp
配置
设置以下环境变量:
export DOKPLOY_URL="https://your-dokploy-instance.com"
export DOKPLOY_API_KEY="your-api-key-here"
获取您的API密钥
您可以在Dokploy仪表板中创建API密钥:
- 首选 设置 → 简介/概况 在您的Dokploy仪表板中
- 导航至
/dashboard/settings/profile - 生成一个新的API密钥
- 复制密钥并将其用作
DOKPLOY_API_KEY环境变量
与Claude桌面版的使用
在您的Claude桌面配置中添加:
{
"mcpServers": {
"dokploy": {
"command": "npx",
"args": ["-y", "dokploy-mcp"],
"env": {
"DOKPLOY_URL": "https://your-dokploy-instance.com",
"DOKPLOY_API_KEY": "your-api-key-here"
}
}
}
}
可用工具
要查看所有可用工具的完整列表、它们的描述以及当前状态,请参阅:
📋 工具状态.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 桌面配置
{
"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 翻译为中文是:“工具状态说明文件”或“工具状态文档”。这里,“TOOLS”指的是工具,“STATUS”指的是状态,而“.md”是Markdown文件格式的后缀,表示这是一个用Markdown编写的文档。因此,整个文件名可以理解为一个描述工具当前状态的Markdown文档。
开发模式
要永久启用额外工具,请修改 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
}
文档
- TOOLS_STATUS.md 翻译为中文是:“工具状态说明文件” - 所有380种工具的完整清单及其状态
- API覆盖率 - 已启用/禁用工具的详细分类
发展
# 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)
