JinDaGe - coolify-mcp-server MCP Details

article

README

🚀 Coolify MCP 服务器

Coolify MCP 服务器提供与 Coolify API 的集成，支持通过 Model Context Protocol (MCP) 工具与 Coolify 实例进行交互，为用户提供便捷的管理体验。

兼容性: 已测试与 Coolify 版本 4.0.0-beta.397 兼容

🚀 快速开始

先决条件

Node.js 18 或更高版本
Coolify 基础 URL
Coolify API 令牌

✨ 主要特性

团队管理：支持列出团队、获取团队详细信息以及团队成员信息。
服务器管理：可进行服务器的创建、验证操作，还能获取服务器资源和域名信息。
服务生命周期管理：能够启动、停止和重启服务。
应用程序生命周期管理：支持启动、停止、重启应用程序，还可执行命令。
部署跟踪：可对部署情况进行跟踪。
私钥管理：提供私钥管理功能。
版本和健康检查：可检查版本信息和 API 健康状态。

📦 安装指南

# 全局安装
npm install -g coolify-mcp-server

# 或使用 npx
npx coolify-mcp-server

📚 详细文档

配置

该服务器需要两个环境变量：

COOLIFY_BASE_URL：你的 Coolify 实例的基础 URL
COOLIFY_TOKEN：你的 Coolify API 令牌

获取 API 令牌

打开你的 Coolify 实例。
转到 Keys & Tokens / API tokens。
创建一个具有以下权限的新令牌：
- read（用于获取信息）
- write（用于管理资源）
- deploy（用于部署操作）

使用方法

在 MCP 设置中

将以下内容添加到你的 MCP 设置配置中：

{
  "mcpServers": {
    "coolify": {
      "command": "npx",
      "args": ["-y", "coolify-mcp-server"],
      "env": {
        "COOLIFY_BASE_URL": "your-coolify-url",
        "COOLIFY_TOKEN": "your-api-token"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

Windows 命令行用户可能需要以下配置：

{
  "mcpServers": {
    "coolify": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "coolify-mcp-server"
      ],
      "env": {
        "COOLIFY_BASE_URL": "your-coolify-url",
        "COOLIFY_TOKEN": "your-api-token"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

可用工具

| 工具分类 | 工具名称 | 功能 | | ---- | ---- | ---- | | 版本与健康 | get_version | 获取 Coolify 版本信息 | | 版本与健康 | health_check | 检查 Coolify API 健康状态 | | 团队 | list_teams | 列出所有团队 | | 团队 | get_team | 获取特定团队的详细信息 | | 团队 | get_current_team | 获取当前团队的详细信息 | | 团队 | get_current_team_members | 获取当前团队成员 | | 服务器 | list_servers | 列出所有服务器 | | 服务器 | create_server | 创建新服务器 | | 服务器 | validate_server | 验证服务器配置 | | 服务器 | get_server_resources | 获取服务器资源使用情况 | | 服务器 | get_server_domains | 获取服务器域名 | | 服务 | list_services | 列出所有服务 | | 服务 | get_service | 获取特定服务的详细信息 | | 服务 | start_service | 启动服务 | | 服务 | stop_service | 停止服务 | | 服务 | restart_service | 重启服务 | | 应用程序 | list_applications | 列出所有应用程序 | | 应用程序 | get_application | 获取特定应用程序的详细信息 | | 应用程序 | start_application | 启动应用程序 | | 应用程序 | stop_application | 停止应用程序 | | 应用程序 | restart_application | 重启应用程序 | | 应用程序 | execute_command | 执行命令 | | 部署 | list_deployments | 列出所有部署 | | 部署 | get_deployment | 获取特定部署的详细信息 | | 部署 | deploy_application | 部署应用程序 | | 部署 | undeploy_application | 解除部署 |

📄 许可证

本项目采用 MIT 许可证。

coolify-mcp-server