mcpField
C
Coolifymcp

Coolifymcp

本地服务
github.com/HowieDuhzit开发工具658 周前更新
代码仓库

关于 Coolifymcp

Coolifymcp 是通过 MCP 调用 Coolify API 的服务，面向需要管理 Coolify 环境的 AI 助手和 IDE 用户。它将 API 功能整合为 18 个工具，覆盖应用、数据库、服务器、部署等管理操作。

主要功能

  1. 0118 个整合式 MCP 工具
  2. 02管理应用与部署
  3. 03管理数据库与服务
  4. 04管理团队、项目和环境
  5. 05管理服务器与安全密钥

适用场景

  1. 01通过 AI 助手管理 Coolify 应用生命周期
  2. 02查看部署并触发应用部署
  3. 03管理数据库、服务器和环境变量

MCP 相关

该 MCP 服务通过 18 个整合工具向 MCP 客户端开放 Coolify API 操作，涵盖应用、数据库、服务器、服务、部署及相关管理。

#coolifymcp#api-management#ai-assistant

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
  "mcpServers": {
    "CoolifyMCP": {
      "command": "npx",
      "args": [
        "-y",
        "coolifymcp"
      ],
      "env": {
        "COOLIFY_API_TOKEN": "<COOLIFY_API_TOKEN>",
        "COOLIFY_BASE_URL": "<COOLIFY_BASE_URL>"
      }
    }
  }
}
启动命令npx -y coolifymcp
需要配置的环境变量
COOLIFY_API_TOKEN密钥
COOLIFY_BASE_URL

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包
npmcoolifymcp

工具

37

收录的工具列表 · 更新于 2 周前

参数类型必填说明
actionenum是要执行的操作：health（系统健康检查）、version（获取 API 版本）、info（获取系统信息）health | version | info

详细介绍

CoolifyMCP

安装 MCP 服务

许可证：MIT Node.js 版本 TypeScript

功能全面的 Model Context Protocol（MCP） 服务，可完整访问 Coolify 的所有 API 端点。CoolifyMCP 让 AI 助手能够与 Coolify 交互，以管理应用程序、数据库、服务器、部署等。

为 Coolify 打造 - 一个开源且可自托管的 Heroku / Netlify / Vercel 替代方案

📖 目录

✨ 功能

  • 🎯 100% API 覆盖率：完整实现所有 Coolify API 端点
  • 🛠️ 18 个整合的 MCP 工具：通过 MCP 协议精简访问 Coolify 的各项功能
  • 🔒 类型安全：使用 TypeScript 构建，提供可靠的错误处理和开发体验
  • 🚀 可用于生产环境：提供健康检查、完善的日志记录和监控
  • 📦 模块化架构：代码库整洁、易于维护，职责划分清晰
  • 🔧 功能全面：支持 Coolify 的所有功能，包括：
    • 👥 团队和项目管理
    • 🚀 应用程序生命周期管理
    • 🗄️ 数据库管理（PostgreSQL、MySQL、MongoDB、Redis 等）
    • 🖥️ 服务器管理和验证
    • 🐳 服务管理
    • 📦 部署管理
    • 🔐 环境变量
    • 🔑 安全密钥管理

🚀 快速开始

在 AI IDE 中安装

CoolifyMCP 适用于所有支持 Model Context Protocol（MCP）的主流 AI IDE。选择你常用的 IDE：

Cursor IDE（推荐）
  1. 打开 Cursor，前往 Settings → Extensions → MCP
  2. 将以下配置添加到 ~/.cursor/mcp.json：
{
  "mcpServers": {
    "coolifymcp": {
      "command": "npx",
      "args": ["coolifymcp"],
      "env": {
        "COOLIFY_API_TOKEN": "your_coolify_api_token_here",
        "COOLIFY_BASE_URL": "https://your-coolify-instance.com/api/v1"
      }
    }
  }
}
Claude Desktop
  1. 打开 Claude Desktop 设置
  2. 将以下配置添加到 MCP 设置中：
{
  "mcpServers": {
    "coolifymcp": {
      "command": "npx",
      "args": ["coolifymcp"],
      "env": {
        "COOLIFY_API_TOKEN": "your_coolify_api_token_here",
        "COOLIFY_BASE_URL": "https://your-coolify-instance.com/api/v1"
      }
    }
  }
}
JetBrains AI Assistant
  1. 打开 JetBrains IDE（IntelliJ、WebStorm 等）
  2. 前往 Settings → Tools → AI Assistant → Model Context Protocol (MCP)
  3. 点击 “Add” 并进行配置：
    • 名称：coolifymcp
    • 命令：npx
    • 参数：["coolifymcp"]
    • 环境变量：
      • COOLIFY_API_TOKEN：your_coolify_api_token_here
      • COOLIFY_BASE_URL：https://your-coolify-instance.com/api/v1
其他兼容 MCP 的 IDE
  • LibreChat：在设置中添加 MCP 服务配置
  • Klavis AI：在平台的 MCP 设置中进行配置
  • 自定义 MCP 客户端：使用相同的配置格式
本地开发
# Clone and install
git clone https://github.com/howieduhzit/coolifymcp.git
cd coolifymcp
npm install
npm run build

# Run with environment variables
COOLIFY_API_TOKEN="your_token_here" COOLIFY_BASE_URL="https://your-coolify-instance.com/api/v1" npm start

📋 先决条件

  • Node.js 20+ - 下载
  • npm 9+ 或 yarn - 包管理器
  • Coolify API 令牌 - 从你的 Coolify 控制面板获取
  • Coolify 实例 URL - 你的 Coolify 实例（默认：https://app.coolify.io/api/v1）

🛠️ 安装

NPM 安装（推荐）
  1. 使用 npx 安装并运行（无需安装）：
npx coolifymcp
  1. 或全局安装：
npm install -g coolifymcp
coolifymcp
本地开发
  1. 克隆仓库：
git clone https://github.com/howieduhzit/coolifymcp.git
cd coolifymcp
  1. 安装依赖：
npm install
  1. 构建项目：
npm run build
  1. 使用环境变量运行：
COOLIFY_API_TOKEN="your_token_here" COOLIFY_BASE_URL="https://your-coolify-instance.com/api/v1" npm start

⚙️ 配置

环境变量
变量描述必填默认值
COOLIFY_API_TOKEN你的 Coolify API 令牌是-
COOLIFY_BASE_URLCoolify API 基础 URL否https://app.coolify.io/api/v1
NODE_ENV环境模式否development
PORT健康检查服务端口否3000
MCP 客户端配置

所有兼容 MCP 的 IDE 均使用一致的配置格式。以下是常见位置：

配置文件位置：
  • Cursor：~/.cursor/mcp.json
  • Claude Desktop：应用中的 MCP 设置
  • JetBrains：设置 → 工具 → AI Assistant → MCP
  • LibreChat：设置 → MCP 服务
  • 自定义客户端：请参阅客户端文档
标准配置：
{
  "mcpServers": {
    "coolifymcp": {
      "command": "npx",
      "args": ["coolifymcp"],
      "env": {
        "COOLIFY_API_TOKEN": "your_token_here",
        "COOLIFY_BASE_URL": "https://your-coolify-instance.com/api/v1"
      }
    }
  }
}
环境变量：
  • COOLIFY_API_TOKEN（必填）：你的 Coolify API 令牌
  • COOLIFY_BASE_URL（可选）：你的 Coolify 实例 URL（默认值为 https://app.coolify.io/api/v1）

🎯 可用工具

Coolify MCP 服务提供 18 个整合工具，通过基于操作的参数涵盖 Coolify 的所有功能：

系统管理（1 个工具）
  • coolify_system - 系统健康状态、版本和信息管理
    • 操作：health、version、info
团队管理（1 个工具）
  • coolify_teams - 完整的团队管理操作
    • 操作：list、current、get、members
项目管理（2 个工具）
  • coolify_projects - 项目 CRUD 操作
    • 操作：list、create、get、update、delete
  • coolify_project_environments - 项目环境管理
    • 操作：list、create、get、delete
应用管理（5 个工具）
  • coolify_applications - 应用 CRUD 操作（所有类型）
    • 操作：list、create、update、get、delete
    • 支持：public、private_github、private_deploy_key、dockerfile、dockerimage、dockercompose
  • coolify_application_lifecycle - 应用生命周期管理
    • 操作：start、stop、restart
  • coolify_application_envs - 应用环境变量
    • 操作：list、create、bulk_update、delete
  • coolify_logs - 获取应用日志
    • 操作：get
  • coolify_application_deployments - 应用部署管理
    • 操作：list、get、trigger
数据库管理（3 个工具）
  • coolify_databases - 数据库 CRUD 操作
    • 操作：list、create、get、update、delete
  • coolify_database_lifecycle - 数据库生命周期管理
    • 操作：start、stop、restart
  • coolify_database_types - 创建特定类型的数据库
    • 操作：create（PostgreSQL、MySQL、MongoDB、Redis）
服务端管理（2 个工具）
  • coolify_servers - 服务端 CRUD 操作
    • 操作：list、create、get、update、delete
  • coolify_server_management - 服务端操作和资源管理
    • 操作：validate、domains、resources
服务管理（3 个工具）
  • coolify_services - 服务 CRUD 操作
    • 操作：list、create、get、update、delete
  • coolify_service_lifecycle - 服务生命周期管理
    • 操作：start、stop、restart
  • coolify_service_envs - 服务环境变量
    • 操作：list、create、update、bulk_update、delete
安全管理（1 个工具）
  • coolify_security_keys - 安全密钥管理
    • 操作：list、create、get、update、delete

🏗️ 开发

脚本
  • npm run build - 将 TypeScript 构建为 JavaScript
  • npm start - 启动生产服务器
  • npm run dev - 启动支持热重载的开发服务器
项目结构
coolify-mcp-server/
├── src/
│   └── index.ts          # Main MCP server implementation
├── dist/                 # Compiled JavaScript output
├── Dockerfile           # Docker configuration
├── docker-compose.yaml  # Docker Compose configuration
├── package.json         # Dependencies and scripts
├── tsconfig.json        # TypeScript configuration
├── config.example.env   # Environment variables template
└── README.md           # This file

🔧 API 覆盖范围

此 MCP 服务提供对 Coolify API 100% 的覆盖，通过 18 个整合工具涵盖全部 83+ 个 API 端点：

  • ✅ 系统管理（1 个工具）- 健康状态、版本和系统信息
  • ✅ 团队管理（1 个工具）- 完整的团队操作
  • ✅ 项目管理（2 个工具）- 项目和环境
  • ✅ 应用管理（5 个工具）- 所有应用类型及其生命周期
  • ✅ 数据库管理（3 个工具）- 所有数据库类型和操作
  • ✅ 服务管理（2 个工具）- 服务操作和资源
  • ✅ 服务管理（3 个工具）- 服务操作及其生命周期
  • ✅ 安全管理（1 个工具）- 安全密钥和身份验证

整合的主要优势：

  • 🎯 降低复杂性：18 个工具，取代 83+ 个独立工具
  • 🚀 提升性能：减少工具定义，API 更简洁
  • 🔧 易于维护：基于操作的参数，组织更有条理
  • 📚 简化文档：工具类别和操作一目了然

🚀 生产环境部署

健康检查

服务器在生产模式（NODE_ENV=production）下运行时，会在 /health 提供健康检查端点。

环境配置

生产环境部署时，请确保：

  1. 设置 NODE_ENV=production
  2. 提供有效的 COOLIFY_API_TOKEN
  3. 设置正确的 COOLIFY_BASE_URL
  4. 配置适当的日志记录
  5. 设置监控和告警

📝 许可证

MIT 许可证 - 详情请参阅 LICENSE 文件。

🤝 参与贡献

  1. Fork 此仓库
  2. 创建功能分支
  3. 进行修改
  4. 适用时添加测试
  5. 提交拉取请求

📚 文档

  • README.md - 完整文档和使用示例
  • GitHub Repository - 源代码和问题跟踪

📞 支持

如有问题或疑问：

🙏 致谢

此项目为 Coolify 打造并由其支持。Coolify 是一个出色的开源平台，让自托管应用变得极其简单。特别感谢 Coolify 团队和社区打造了如此强大的工具。

📄 许可证

此项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件。

为 Coolify 社区倾情打造 ❤️

GitHub stars GitHub forks GitHub issues

由 Coolify 提供支持 - 一个开源且可自托管的 Heroku / Netlify / Vercel 替代方案，拥有 45.2k+ 颗星 ⭐

评论

支持 Markdown

第一次接触 MCP？

从协议是什么，到在客户端里装上第一个服务，这几条回答覆盖了大多数入门问题。

一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。