Coolify MCP

🚀 Coolify MCP Server

A Model Context Protocol (MCP) server implementation for Coolify that enables AI assistants to interact with your Coolify instance through natural language.

🚀 Quick Start

This MCP server allows AI assistants to interact with your Coolify instance via natural language. Below are some example prompts for interacting with an MCP-compatible AI assistant.

💻 Usage Examples

Example Prompts

Here are example prompts that can be used to interact with an MCP-compatible AI assistant:

Server Management

# List and check servers
- Show me all Coolify servers in my instance.
- What's the status of the server {uuid}?
- Show the resources running on the server {uuid}.
- Which domain names are configured for the server {uuid}?
- Can you verify the connection to the server {uuid}?

# Resource monitoring
- How much CPU and memory is the server {uuid} using?
- List all running resources on the server {uuid}.
- Show the current status of all servers.

Project Management

# Project operations
- List all my Coolify projects.
- Create a new project named "my-webapp" with the description "My web application".
- Show the detailed information of the project {uuid}.
- Update the project {uuid} to change its name to "new-name".
- Delete the project {uuid}.

# Environment management
- List the environments in the project {uuid}.
- View the details of the production environment of the project {uuid}.
- Show the variables set in the staging environment of the project {uuid}.

Application and Service Management

# Application management
- List all applications.
- Show the detailed information of the application {uuid}.
- Create a new application named "my-nodejs-app".
- Delete the application {uuid}.

# Service management
- List all services of the application {uuid}.
- Show the current status of the service {uuid}.
- Update the configuration of the service {uuid}.

Database Management

# Database operations
- Create a new database instance.
- Delete the specified database instance.
- Show a list of all available databases.
- Update the configuration parameters of the database.

Deployment Management

# Deployment operations
- List all deployment records.
- View the status and detailed information of the deployment {uuid}.
- Undo an existing deployment.

📦 Installation

Prerequisites

1. Install Node.js and npm.
2. Ensure the latest version of the Coolify CLI is installed.
3. Prepare your API key and access token.

Setup in Different Tools

Setup in ChatGPT

1. Add environment variables to the configuration:

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

2. Run the installation command:

   npm install coolify-mcp-server
   

Setup in Other Tools

Refer to the documentation of the specific tool for corresponding configuration.

📚 Documentation

Local Setup

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

3. Start the development server:

   npm run dev
   

Environment Variables

# Example environment variable configuration
COOLIFY_ENV=development
COOLIFY_API_KEY=your_api_key_here

🔧 Technical Details

API Reference

Resource Type Definitions

Application Interface

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

Service Interface

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

Database Interface

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

Deployment Interface

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

🤝 Contribution

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

📄 License

This project is licensed under the MIT license.

🛠️ Support

If you need support, please follow these steps:

1. Check the Issues page.
2. Create a new issue if necessary.
3. Join the Coolify community.