Coolifymcp

by HowieDuhzit

256 downloads
Not rated
GitHub

About

CoolifyMCP provides complete access to all Coolify API endpoints through 18 consolidated tools. Enable AI assistants to manage applications, databases, servers, and deployments directly from your IDE.

Details

Author
HowieDuhzit
Downloads
256
Categories
Developer Tools

- 100% API coverage of all Coolify endpoints
- 18 consolidated MCP tools for streamlined access
- TypeScript for type safety and robust error handling
- Production-ready with health checks and logging
- Easy installation via npx coolifymcp

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Coolifymcp
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Install via npx coolifymcp and configure environment variables COOLIFY_API_TOKEN (required) and COOLIFY_BASE_URL (optional, defaults to https://app.coolify.io/api/v1). Add the MCP server configuration to your compatible IDE (e.g., Cursor, Claude Desktop, JetBrains AI Assistant) as shown in the README.

coolify_system

System management operations - health check, version, and system information

coolify_teams

Complete team management - list teams, get current team, get team details, and list team members

coolify_projects

Project CRUD operations - list, create, get, update, and delete projects

coolify_project_environments

Project environment management - list, create, get, and delete project environments

coolify_applications

Application CRUD operations - list, create, update, get, and delete applications of all types

coolify_application_lifecycle

Application lifecycle management - start, stop, and restart applications

coolify_application_envs

Application environment variables management - list, create, bulk update, and delete environment variables

coolify_logs

Application logs and monitoring - get application logs

coolify_application_deployments

Application deployment management - list, get, and trigger deployments

coolify_databases

Database CRUD operations - list, create, get, update, and delete databases

coolify_database_lifecycle

Database lifecycle management - start, stop, and restart databases

coolify_database_types

Specific database type creation - create PostgreSQL, MySQL, MongoDB, and Redis databases with type-specific parameters

coolify_servers

Server CRUD operations - list, create, get, update, and delete servers

coolify_server_management

Server operations and resources - validate server connection, list domains, and list resources

coolify_services

Service CRUD operations - list, create, get, update, and delete services

coolify_service_lifecycle

Service lifecycle management - start, stop, and restart services

coolify_service_envs

Service environment variables management - list, create, update, bulk update, and delete environment variables

coolify_security_keys

Security keys management - list, create, get, update, and delete security keys

coolify_knowledge_search

Search through Coolify documentation, examples, and knowledge base

coolify_knowledge_get_document

Get a specific document from the Coolify knowledge base by ID

coolify_knowledge_list_categories

List all available knowledge base categories and their descriptions

coolify_knowledge_get_category

Get all documents in a specific knowledge base category

coolify_templates_list

List available one-click service templates and Docker Compose examples

coolify_templates_get

Get a specific template configuration by name or ID

coolify_templates_validate

Validate a Docker Compose template or configuration

coolify_docker_compose_generate

Generate Docker Compose configuration for common application stacks

coolify_docker_compose_optimize

Optimize Docker Compose configuration for Coolify deployment

coolify_monitoring_setup

Set up monitoring stack with Prometheus, Grafana, and alerting

coolify_health_check_generator

Generate health check configurations for applications

coolify_webhook_setup

Set up webhooks for CI/CD integration and automation

coolify_backup_setup

Set up automated backup configuration for databases and applications

coolify_security_audit

Perform security audit of Coolify deployment and configurations

coolify_ssl_setup

Set up SSL certificates and HTTPS configuration

coolify_performance_analyze

Analyze application performance and provide optimization recommendations

coolify_scaling_recommendations

Get scaling recommendations based on current usage patterns

coolify_development_environment

Set up development environment with hot reload and debugging

coolify_testing_setup

Set up testing environment with automated testing tools

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "coolifymcp": {
            "coolifymcp": {
                "command": "npx",
                "args": [
                    "coolifymcp"
                ],
                "env": {
                    "COOLIFY_API_TOKEN": "your_coolify_api_token_here",
                    "COOLIFY_BASE_URL": "https://your-coolify-instance.com/api/v1"
                }
            }
        }
    }
}

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"
        }
    }
}

CoolifyMCP

A comprehensive Model Context Protocol (MCP) server that provides complete access to all Coolify API endpoints. CoolifyMCP enables AI assistants to interact with Coolify for managing applications, databases, servers, deployments, and more. > Built for Coolify - An open-source & self-hostable Heroku / Netlify / Vercel alternative

✨ Features

- 🎯 100% API Coverage: Complete implementation of all Coolify API endpoints - 🛠️ 18 Consolidated MCP Tools: Streamlined access to Coolify's functionality through MCP protocol - 🔒 Type Safety: Built with TypeScript for robust error handling and development experience - 🚀 Production Ready: Health checks, proper logging, and monitoring - �� NPM Distribution: Easy installation via npx coolifymcp

🚀 Quick Start

Install in Your AI IDE

CoolifyMCP works with all major AI IDEs that support the Model Context Protocol (MCP):

Cursor IDE (Recommended)

1. Open Cursor and go to Settings → Extensions → MCP 2. Add this configuration to your ~/.cursor/mcp.json: ``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. Open Claude Desktop settings 2. Add the same configuration to your MCP settings

JetBrains AI Assistant

1. Open your JetBrains IDE (IntelliJ, WebStorm, etc.) 2. Go to Settings → Tools → AI Assistant → Model Context Protocol (MCP) 3. Click "Add" and configure: - Name:
coolifymcp - Command: npx - Arguments: ["coolifymcp"] - Environment Variables: - COOLIFY_API_TOKEN: your_coolify_api_token_here - COOLIFY_BASE_URL: https://your-coolify-instance.com/api/v1

Other MCP-Compatible IDEs

- LibreChat: Add MCP server configuration in settings - Klavis AI: Configure in your platform's MCP settings - Custom MCP Clients: Use the same configuration format

🎯 Available Tools

The Coolify MCP Server provides 18 consolidated tools that cover all Coolify functionality:

System Management (1 tool)

-
coolify_system - System health, version, and information management

Team Management (1 tool)

-
coolify_teams - Complete team management operations

Project Management (2 tools)

-
coolify_projects - Project CRUD operations - coolify_project_environments - Project environment management

Application Management (5 tools)

-
coolify_applications - Application CRUD operations (all types) - coolify_application_lifecycle - Application lifecycle management - coolify_application_envs - Application environment variables - coolify_logs - Application logs retrieval - coolify_application_deployments - Application deployment management

Database Management (3 tools)

-
coolify_databases - Database CRUD operations - coolify_database_lifecycle - Database lifecycle management - coolify_database_types - Specific database type creation

Server Management (2 tools)

-
coolify_servers - Server CRUD operations - coolify_server_management - Server operations and resources

Service Management (3 tools)

-
coolify_services - Service CRUD operations - coolify_service_lifecycle - Service lifecycle management - coolify_service_envs - Service environment variables

Security Management (1 tool)

-
coolify_security_keys - Security key management

�� Prerequisites

- Node.js 20+ - Download - npm 9+ or yarn - Package manager - Coolify API token - Get from your Coolify dashboard - Coolify instance URL - Your Coolify instance (default:
https://app.coolify.io/api/v1)

🔧 Configuration

Environment Variables

| Variable | Description | Required | Default | |----------|-------------|----------|---------| |
COOLIFY_API_TOKEN | Your Coolify API token | Yes | - | | COOLIFY_BASE_URL | Coolify API base URL | No | https://app.coolify.io/api/v1 | | NODE_ENV | Environment mode | No | development | | PORT | Health check server port | No | 3000` |

�� Key Benefits

- Reduced Complexity: 18 tools instead of 83+ individual tools - Better Performance: Fewer tool definitions and cleaner API calls - Easier Maintenance: Action-based parameters for better organization - Simplified Documentation: Clear tool categories and actions - 100% API Coverage: All Coolify endpoints accessible through consolidated interface

📚 Documentation

- GitHub Repository - Source code and issue tracking - Coolify Documentation - Official Coolify platform docs

📞 Support

For issues and questions: - 📝 Create an issue in the repository - �� Check the Coolify documentation - �� Join the Coolify community

🙏 Acknowledgments

This project is built for and powered by Coolify - an amazing open-source platform that makes self-hosting applications incredibly easy. Special thanks to the Coolify team and community for creating such a powerful tool. --- Built with ❤️ for the Coolify community GitHub stars GitHub forks GitHub issues
No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.