项目简介

Coolify MCP Server 是一个基于 Model Context Protocol 的服务器，它作为 Coolify API 的集成层，使得用户可以通过标准化的 MCP 接口来管理 Coolify 中的各种资源和应用。借助此服务器，LLM 应用能够以结构化的方式访问和操作 Coolify 的功能，例如应用部署、状态管理和资源检索等。

主要功能点

• 资源与应用管理: 列出和检索 Coolify 中管理的资源和应用信息。
• 应用生命周期管理: 支持启动、停止和重启 Coolify 中部署的应用。
• 应用部署: 允许通过指定标签或 UUID 部署 Coolify 应用的新版本。
• 健康检查: 提供 Coolify 服务器的健康状态检查功能。
• 版本信息: 获取当前 Coolify API 的版本信息。

安装步骤

1. 克隆仓库

   git clone https://github.com/StuMason/coolify-mcp-server.git
   cd coolify-mcp-server
   

2. 安装依赖并构建

   npm install
   npm run build
   

3. 配置环境变量

   在运行服务器之前，您需要配置以下环境变量：

   • 'COOLIFY_ACCESS_TOKEN': 您的 Coolify API 访问令牌。您需要从 Coolify 控制面板获取。
   • 'COOLIFY_BASE_URL': 您的 Coolify 服务器的 URL。例如 'https://your-coolify-url.co.uk'。

   您可以通过多种方式设置环境变量，例如在 '.env' 文件中，或者直接在 shell 中导出。

服务器配置

要将 Coolify MCP Server 集成到 MCP 客户端（例如 Claude 客户端），您需要在客户端的配置文件中添加如下服务器配置。请根据您的实际环境修改 'args' 和 'env' 中的路径和参数。

{
    "mcpServers": {
        "coolify": {
            "command": "node",
            "args": [
                "/path/to/coolify-mcp-server/build/index.js"  // 请替换为 coolify-mcp-server 项目 build 目录下 index.js 文件的实际路径
            ],
            "env": {
                "COOLIFY_ACCESS_TOKEN": "your_coolify_api_key", // 请替换为您的 Coolify API 访问令牌
                "COOLIFY_BASE_URL": "https://your-coolify-url.co.uk"  // 请替换为您的 Coolify 服务器 URL
            }
        }
    }
}

配置参数说明:

• 'server name': 服务器名称，此处为 "coolify"。
• 'command': 启动服务器的命令，此处为 'node'，表示使用 Node.js 运行时。
• 'args': 传递给 'command' 的参数，此处指定了 'build/index.js' 文件的路径，指向编译后的服务器入口文件。请务必修改为实际的文件路径。
• 'env': 传递给服务器进程的环境变量。
  • 'COOLIFY_ACCESS_TOKEN': 必填，Coolify API 的访问令牌，用于服务器鉴权。请替换为您的实际令牌。
  • 'COOLIFY_BASE_URL': 必填，Coolify 服务器的根 URL。请替换为您的 Coolify 服务器地址。

基本使用方法

1. 确保 MCP 客户端已正确配置上述服务器信息。
2. 客户端启动后，即可通过 MCP 协议与 Coolify MCP Server 通信。
3. 客户端可以发送 'list-resources', 'list-applications', 'start-application' 等 MCP 请求，调用 Coolify 提供的各项功能。
4. 服务器会将 Coolify API 的响应数据以 JSON 格式返回给客户端。

具体可参考 Model Context Protocol (MCP) 了解更多 MCP 协议和客户端使用方法。