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 社區。