Coolify MCP

🚀 Coolify MCP 服务器

Coolify MCP 服务器是为 Coolify 实现的 Model Context Protocol (MCP) 服务器，它能让 AI 助手通过自然语言与您的 Coolify 实例进行交互，极大提升了操作的便捷性和效率。

🚀 快速开始

Coolify MCP 服务器允许您借助自然语言与 Coolify 实例进行交互。以下是一些示例提示，可用于与 MCP 兼容的 AI 助手进行交互。

✨ 主要特性

• 多方面管理：支持对 Coolify 的服务器、项目、应用程序、服务、数据库和部署等进行全面管理。
• 自然语言交互：通过自然语言提示即可完成各种操作，无需复杂的命令。

📦 安装指南

先决条件

1. 安装 Node.js 和 npm。
2. 确保安装了最新版本的 Coolify CLI。
3. 准备好 API 密钥和访问令牌。

在不同工具中的设置

在 ChatGPT 中的设置

1. 将环境变量添加到配置中：

   export COOLIFY_ACCESS_TOKEN=your_token
   export COOLIFY_BASE_URL=https://api.your-coolify-instance.com
   

2. 运行安装命令：

   npm install coolify-mcp-server
   

在其他工具中的设置

请参考具体工具的文档进行相应配置。

💻 使用示例

服务器管理

# 列出和检查服务器
- 显示我实例中的所有 Coolify 服务器
- {uuid} 这台服务器的状态如何？
- 展示 {uuid} 服务器上运行的资源
- {uuid} 服务器配置了哪些域名？
- 能否验证对 {uuid} 服务器的连接？

# 资源监控
- {uuid} 服务器使用了多少 CPU 和内存？
- 列出 {uuid} 服务器上所有运行的资源
- 展示所有服务器的当前状态

项目管理

# 项目操作
- 列出我所有的 Coolify 项目
- 创建一个名为 "my-webapp" 的新项目，描述为 "我的网络应用程序"
- 展示 {uuid} 项目的详细信息
- 更新 {uuid} 项目以将其名称更改为 "new-name"
- 删除 {uuid} 项目

# 环境管理
- 列出项目 {uuid} 中的环境
- 查看项目 {uuid} 的生产环境详情
- 展示项目 {uuid} 竞态环境中设置的变量

应用程序和服务管理

# 应用程序管理
- 列出所有应用程序
- 展示 {uuid} 应用程序的详细信息
- 创建一个名为 "my-nodejs-app" 的新应用程序
- 删除 {uuid} 应用程序

# 服务管理
- 列出 {uuid} 应用程序的所有服务
- 显示 {uuid} 服务的当前状态
- 更新 {uuid} 服务的配置

数据库管理

# 数据库操作
- 创建一个新的数据库实例
- 删除指定的数据库实例
- 展示所有可用数据库的列表
- 更新数据库的配置参数

部署管理

# 部署操作
- 列出所有部署记录
- 查看 {uuid} 部署的状态和详细信息
- 撤销一个已有的部署

📚 详细文档

开发信息

本地设置

1. 克隆仓库：

   git clone https://github.com/your-username/coolify-mcp.git
   cd coolify-mcp
   

2. 安装依赖：

   npm install
   

3. 启动开发服务器：

   npm run dev
   

环境变量

# 示例环境变量配置
COOLIFY_ENV=development
COOLIFY_API_KEY=your_api_key_here

API 参考

资源类型定义

应用程序接口

interface Application {
  id: number;
  uuid: string;
  name: string;
  description?: string;
}

服务接口

interface Service {
  id: number;
  uuid: string;
  application_uuid: string;
  name: string;
  status: 'running' | 'stopped';
  configuration: Record<string, any>;
}

数据库接口

interface Database {
  id: number;
  uuid: string;
  name: string;
  type: 'mysql' | 'postgres' | 'sqlite';
  is_public: boolean;
  public_port?: number;
}

部署接口

interface Deployment {
  id: number;
  uuid: string;
  application_uuid: string;
  status: string;
  created_at: string;
  updated_at: string;
}

🤝 贡献指南

欢迎贡献！请随意提交 Pull Request。对于重大变更，请先打开问题讨论您希望更改的内容。

📄 许可证

本项目采用 MIT 许可证。

🛠️ 支持

如需支持，请按照以下步骤操作：

1. 检查 问题 页面。
2. 如果需要，创建新问题。
3. 加入 Coolify 社区。