使用说明
项目简介
Coolify MCP Server 是一个 MCP 服务器实现,它充当 LLM 客户端和 Coolify API 之间的桥梁。通过提供一系列预定义的工具,该服务器允许 LLM 自动化管理 Coolify 基础设施,例如服务器、服务、应用程序和部署。这使得用户可以通过自然语言指令,利用 LLM 客户端与 Coolify 平台进行交互,实现基础设施的自动化管理和监控。
主要功能点
- 团队管理: 列出、获取团队详情和成员信息。
- 服务器管理: 创建、验证服务器,获取服务器资源和域名信息。
- 服务生命周期管理: 启动、停止、重启 Coolify 中的服务。
- 应用生命周期管理: 启动、停止、重启 Coolify 中的应用,并执行应用容器内的命令。
- 部署跟踪: 查看部署历史和详情。
- 私钥管理: 列出和创建私钥。
- 版本和健康检查: 获取 Coolify 版本信息和健康状态。
总而言之,该 MCP Server 提供了一套全面的工具,使 LLM 能够与 Coolify 平台进行深度集成,实现云基础设施的自动化管理。
安装步骤
- 安装 Node.js: 确保你的系统已安装 Node.js 18 或更高版本。
- 全局安装 coolify-mcp-server: 打开终端并执行命令 'npm install -g coolify-mcp-server'。
服务器配置
为了让 MCP 客户端能够连接到 Coolify MCP Server,你需要在 MCP 客户端的设置中配置以下信息。请注意,以下配置为 JSON 格式,您需要根据您的 Coolify 实例信息进行配置:
{ "mcpServers": { "coolify": { "command": "npx", "args": ["-y", "coolify-mcp-server"], "env": { "COOLIFY_BASE_URL": "your-coolify-url", // 替换为你的 Coolify 实例的 Base URL,例如 "https://app.coolify.io" "COOLIFY_TOKEN": "your-api-token" // 替换为你的 Coolify API Token }, "disabled": false, "autoApprove": [] } } }
配置参数说明:
- server name: 'coolify' - 服务器名称,可以自定义。
- command: 'npx' - 运行命令,这里使用 'npx' 来执行 'coolify-mcp-server'。
- args: '["-y", "coolify-mcp-server"]' - 命令参数,'-y' 参数通常用于跳过 npm 的安装确认提示,'coolify-mcp-server' 是要执行的命令。
- env: 环境变量配置,包含连接 Coolify 实例所需的凭据:
- 'COOLIFY_BASE_URL': 必须配置。你的 Coolify 实例的 URL 地址。
- 'COOLIFY_TOKEN': 必须配置。你的 Coolify API Token,需要在 Coolify 后台 "Keys & Tokens" / "API tokens" 中创建,并赋予 'read', 'write', 'deploy' 权限。
- disabled: 'false' - 设置为 'false' 表示启用该 MCP 服务器。
- autoApprove: '[]' - 自动批准的工具列表,这里为空表示不自动批准任何工具,所有工具调用都需要手动批准。
基本使用方法
配置完成后,在 MCP 客户端中,你可以通过自然语言指令调用 Coolify MCP Server 提供的工具来管理 Coolify 资源。例如,你可以询问 "列出我的服务器" 或 "创建一个新的应用"。 LLM 客户端会解析你的指令,并调用 Coolify MCP Server 相应的工具来执行操作,并将结果返回给你。
使用前提:
- Coolify 实例和 API Token: 你需要拥有一个可访问的 Coolify 实例,并生成具有足够权限的 API Token。
- MCP 客户端: 你需要使用支持 MCP 协议的 LLM 客户端,并正确配置上述服务器连接信息。
配置正确后,即可开始使用 LLM 通过 Coolify MCP Server 提供的工具集来管理你的 Coolify 云平台。
信息
分类
开发者工具