返回 MCP 目录
public公开dns本地运行

coolify-mcp

Coolify MCP服务器是一个用于管理Coolify部署的工具,提供程序化的MCP接口和全面的CLI命令,支持应用、服务、数据库等资源的管理。

article

README

🚀 Coolify MCP 服务器

Coolify MCP 服务器是一个用于管理 Coolify 部署的模型上下文协议(MCP)服务器,它既提供了编程式的 MCP 工具,也提供了全面的 CLI 命令。

🚀 快速开始

选项 1:MCP 集成(推荐)

MCP(模型控制协议)允许你直接从 AI 编辑器管理 Coolify。

1. 添加到你的 MCP 配置中

对于 Cursor: 添加到 ~/.cursor/mcp.json<项目文件夹>/.cursor/mcp.json

{
  "mcpServers": {
    "coolify-mcp": {
      "command": "npx",
      "args": ["-y", "@felixallistar/coolify-mcp", "--server"],
      "env": {
        "COOLIFY_API_URL": "https://your-coolify-instance.com",
        "COOLIFY_API_TOKEN": "your-coolify-api-token"
      }
    }
  }
}

对于 VS Code: 添加到 <项目文件夹>/.vscode/mcp.json

{
  "servers": {
    "coolify-mcp": {
      "command": "npx",
      "args": ["-y", "@felixallistar/coolify-mcp", "--server"],
      "env": {
        "COOLIFY_API_URL": "https://your-coolify-instance.com",
        "COOLIFY_API_TOKEN": "your-coolify-api-token"
      },
      "type": "stdio"
    }
  }
}

🔑 请将 your-coolify-instance.com 替换为你实际的 Coolify URL,并将 your-coolify-api-token 替换为你在 Coolify 设置 > API 中获取的 API 令牌。

2.(仅适用于 Cursor)启用 Coolify MCP

打开 Cursor 设置(Ctrl + Shift + J)➡ 点击 MCP 选项卡 ➡ 通过开关启用 coolify-mcp

3. 开始管理 Coolify

在你的 AI 聊天中,尝试以下命令:

List my Coolify applications
Create a new WordPress service called "my-blog" 
Deploy my app with ID "app-123"
Show me all available database types

选项 2:CLI 使用

安装

# 全局安装以用于 CLI
npm install -g @felixallistar/coolify-mcp

# 测试安装
coolify-mcp --help

配置

在你的项目目录中创建一个 .env 文件:

# 必需:你的 Coolify 实例 URL(如有需要,请包含端口)
COOLIFY_API_URL=https://your-coolify-instance.com

# 必需:你的 Coolify API 令牌(在 Coolify 设置 > API 中生成)
COOLIFY_API_TOKEN=your-coolify-api-token

常用命令

# 应用管理
coolify-mcp apps list
coolify-mcp apps create-public --name "my-app" --repository "https://github.com/user/repo" --project "project-id"
coolify-mcp apps start app-id

# 服务管理(70 多种一键服务)
coolify-mcp services types
coolify-mcp services create --name "my-blog" --type "wordpress-with-mysql" --project "project-id"

# 数据库管理(8 种数据库类型)
coolify-mcp databases create-postgresql --name "main-db" --project "project-id"
coolify-mcp databases create-redis --name "cache" --project "project-id"

# 项目管理
coolify-mcp projects list
coolify-mcp projects create --name "My Project"

# 测试连接性
coolify-mcp system health

✨ 主要特性

🔄 应用(21 项操作)

通过 6 种部署类型、环境变量、日志和控制操作,实现完整的应用生命周期管理。

🔧 服务(14 项操作)

70 多种一键服务,包括 WordPress、Ghost、MinIO 等,并提供完整的环境管理。

🗄️ 数据库(13 项操作)

8 种数据库类型:PostgreSQL、MySQL、MariaDB、MongoDB、Redis、KeyDB、ClickHouse、Dragonfly。

📂 项目、服务器、部署

实现完整的基础设施管理,包括私钥、系统管理和部署监控。

💻 MCP 工具与 CLI 命令对比

此软件包提供了两种交互方式,且功能完全相同

  • 🤖 MCP 工具:适用于 AI 代理和 Cursor 集成(推荐)
  • 💻 CLI 命令:适用于直接在终端使用

两种接口提供相同的功能,你可以根据自己的工作流程进行选择。

🔧 技术细节

自动化 API 更新

与 Coolify 的最新 API 保持同步:

npm run refresh           # 下载最新的 API 规范并重新构建
npm run check-updates     # 检查 API 是否有更改

手动开发

git clone https://github.com/FelixAllistar/coolify-mcp.git
cd coolify-mcp
npm install
npm run refresh
npm run dev

📚 详细文档

API 覆盖范围

100% 覆盖 Coolify API - 应用、服务、数据库、项目、服务器、部署、私钥、系统管理

📄 许可证

GLWTPL(祝你好运公共许可证) - 详情请参阅 LICENSE 文件。

此软件可能正常工作,也可能无法正常工作,没有第三种选择。祝你好运,一路顺风。

💻 使用示例

MCP 配置

选项 1:使用 npx(推荐 - 简单!)

{
  "mcpServers": {
    "coolify-mcp": {
      "command": "npx",
      "args": ["-y", "@felixallistar/coolify-mcp", "--server"],
      "env": {
        "COOLIFY_API_URL": "https://your-coolify-instance.com",
        "COOLIFY_API_TOKEN": "your-coolify-api-token"
      }
    }
  }
}

选项 2:直接使用 Node 执行

{
  "mcpServers": {
    "coolify-mcp": {
      "command": "node",
      "args": ["node_modules/@felixallistar/coolify-mcp/dist/index.js", "--server"],
      "env": {
        "COOLIFY_API_URL": "https://your-coolify-instance.com",
        "COOLIFY_API_TOKEN": "your-coolify-api-token"
      }
    }
  }
}

选项 3:全局安装

npm install -g @felixallistar/coolify-mcp

然后使用 MCP 服务器二进制文件:

{
  "mcpServers": {
    "coolify-mcp": {
      "command": "coolify-mcp",
      "env": {
        "COOLIFY_API_URL": "https://your-coolify-instance.com",
        "COOLIFY_API_TOKEN": "your-coolify-api-token"
      }
    }
  }
}

CLI 使用

对于 CLI 命令,只需在 coolify-mcp 命令后添加参数:

# 使用 npx(无需安装)
npx @felixallistar/coolify-mcp --help
npx @felixallistar/coolify-mcp apps list

# 或者全局安装以更方便地使用 CLI
npm install -g @felixallistar/coolify-mcp
coolify-mcp --help
coolify-mcp apps list
help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端