The Coolify MCP Server enables AI assistants to fully manage Coolify infrastructure through 64 comprehensive tools covering all API endpoints.
Core Capabilities:
Health & System Monitoring: Check system health and get API version information
Team Management: List, get, and manage teams and their members
Project Management: Create, list, get, delete projects, and manage project environments
Application Lifecycle: Create applications (public, private GitHub, Dockerfile, Docker image), manage state (start/stop/restart), view logs, and handle deployments
Environment Variables: List, create, bulk update, and delete application environment variables with secret handling
Database Management: Create and manage multiple database types (PostgreSQL, MySQL, MongoDB, Redis, MariaDB, etc.) with full lifecycle control
Server Management: Create, list, update, delete, and validate servers, plus manage server domains and resources
Service Management: Create and manage Docker Compose services with complete lifecycle control
Deployment Management: List deployments, get application-specific deployments, and trigger new deployments
Security & Keys: Manage SSH security keys for server authentication and access control
Enables management of Docker applications and containers through Coolify, including creating Dockerfile and Docker image applications, and controlling their deployment lifecycle.
Allows creation and deployment of private GitHub applications through Coolify's platform, enabling automated deployment workflows from GitHub repositories.
Provides tools for creating, managing, and controlling MongoDB databases through Coolify, including database lifecycle operations like start, stop, and restart.
Enables creation and management of MySQL databases through Coolify's platform, with full control over database operations and configuration.
Allows creation, configuration, and management of PostgreSQL databases through Coolify, including database lifecycle management and administrative operations.
Provides tools for creating and managing Redis databases through Coolify's infrastructure, with support for database operations and configuration management.
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
📖 Table of Contents
- Features
- Quick Start
- Prerequisites
- Installation
- Configuration
- Available Tools
- Development
- API Coverage
- Production Deployment
- Documentation
- Contributing
- License
✨ 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
- 📦 Modular Architecture: Clean, maintainable codebase with separated concerns
- 🔧 Comprehensive: Supports all Coolify features including:
- 👥 Team and Project Management
- 🚀 Application Lifecycle Management
- 🗄️ Database Management (PostgreSQL, MySQL, MongoDB, Redis, etc.)
- 🖥️ Server Management and Validation
- 🐳 Service Management
- 📦 Deployment Management
- 🔐 Environment Variables
- 🔑 Security Keys Management
🚀 Quick Start
Install in Your AI IDE
CoolifyMCP works with all major AI IDEs that support the Model Context Protocol (MCP). Choose your preferred IDE:
Cursor IDE (Recommended)
- Open Cursor and go to Settings → Extensions → MCP
- Add this configuration to your
~/.cursor/mcp.json
:
Claude Desktop
- Open Claude Desktop settings
- Add this configuration to your MCP settings:
JetBrains AI Assistant
- Open your JetBrains IDE (IntelliJ, WebStorm, etc.)
- Go to Settings → Tools → AI Assistant → Model Context Protocol (MCP)
- 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
- Name:
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
Local Development
📋 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
)
🛠️ Installation
NPM Installation (Recommended)
- Install and run with npx (no installation needed):
- Or install globally:
Local Development
- Clone the repository:
- Install dependencies:
- Build the project:
- Run with environment variables:
⚙️ 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 |
MCP Client Configuration
The configuration format is consistent across all MCP-compatible IDEs. Here are the common locations:
Configuration File Locations:
- Cursor:
~/.cursor/mcp.json
- Claude Desktop: MCP settings in the app
- JetBrains: Settings → Tools → AI Assistant → MCP
- LibreChat: Settings → MCP Servers
- Custom Clients: Refer to your client's documentation
Standard Configuration:
Environment Variables:
COOLIFY_API_TOKEN
(required): Your Coolify API tokenCOOLIFY_BASE_URL
(optional): Your Coolify instance URL (defaults tohttps://app.coolify.io/api/v1
)
🎯 Available Tools
The Coolify MCP Server provides 18 consolidated tools that cover all Coolify functionality through action-based parameters:
System Management (1 tool)
coolify_system
- System health, version, and information management- Actions:
health
,version
,info
- Actions:
Team Management (1 tool)
coolify_teams
- Complete team management operations- Actions:
list
,current
,get
,members
- Actions:
Project Management (2 tools)
coolify_projects
- Project CRUD operations- Actions:
list
,create
,get
,update
,delete
- Actions:
coolify_project_environments
- Project environment management- Actions:
list
,create
,get
,delete
- Actions:
Application Management (5 tools)
coolify_applications
- Application CRUD operations (all types)- Actions:
list
,create
,update
,get
,delete
- Supports: public, private_github, private_deploy_key, dockerfile, dockerimage, dockercompose
- Actions:
coolify_application_lifecycle
- Application lifecycle management- Actions:
start
,stop
,restart
- Actions:
coolify_application_envs
- Application environment variables- Actions:
list
,create
,bulk_update
,delete
- Actions:
coolify_logs
- Application logs retrieval- Actions:
get
- Actions:
coolify_application_deployments
- Application deployment management- Actions:
list
,get
,trigger
- Actions:
Database Management (3 tools)
coolify_databases
- Database CRUD operations- Actions:
list
,create
,get
,update
,delete
- Actions:
coolify_database_lifecycle
- Database lifecycle management- Actions:
start
,stop
,restart
- Actions:
coolify_database_types
- Specific database type creation- Actions:
create
(PostgreSQL, MySQL, MongoDB, Redis)
- Actions:
Server Management (2 tools)
coolify_servers
- Server CRUD operations- Actions:
list
,create
,get
,update
,delete
- Actions:
coolify_server_management
- Server operations and resources- Actions:
validate
,domains
,resources
- Actions:
Service Management (3 tools)
coolify_services
- Service CRUD operations- Actions:
list
,create
,get
,update
,delete
- Actions:
coolify_service_lifecycle
- Service lifecycle management- Actions:
start
,stop
,restart
- Actions:
coolify_service_envs
- Service environment variables- Actions:
list
,create
,update
,bulk_update
,delete
- Actions:
Security Management (1 tool)
coolify_security_keys
- Security key management- Actions:
list
,create
,get
,update
,delete
- Actions:
🏗️ Development
Scripts
npm run build
- Build TypeScript to JavaScriptnpm start
- Start the production servernpm run dev
- Start development server with hot reload
Project Structure
🔧 API Coverage
This MCP server provides 100% coverage of the Coolify API with 18 consolidated tools covering all 83+ API endpoints:
- ✅ System Management (1 tool) - Health, version, and system information
- ✅ Team Management (1 tool) - Complete team operations
- ✅ Project Management (2 tools) - Projects and environments
- ✅ Application Management (5 tools) - All application types and lifecycle
- ✅ Database Management (3 tools) - All database types and operations
- ✅ Server Management (2 tools) - Server operations and resources
- ✅ Service Management (3 tools) - Service operations and lifecycle
- ✅ Security Management (1 tool) - Security keys and authentication
Key Benefits of Consolidation:
- 🎯 Reduced Complexity: 18 tools instead of 83+ individual tools
- 🚀 Better Performance: Fewer tool definitions and cleaner API
- 🔧 Easier Maintenance: Action-based parameters for better organization
- 📚 Simplified Documentation: Clear tool categories and actions
🚀 Production Deployment
Health Checks
The server includes a health check endpoint at /health
when running in production mode (NODE_ENV=production
).
Environment Configuration
For production deployment, ensure:
- Set
NODE_ENV=production
- Provide valid
COOLIFY_API_TOKEN
- Set correct
COOLIFY_BASE_URL
- Configure proper logging
- Set up monitoring and alerting
📝 License
MIT License - see LICENSE file for details.
🤝 Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
📚 Documentation
- README.md - Complete documentation and usage examples
- GitHub Repository - Source code and issue tracking
📞 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.
- 🌟 Coolify on GitHub - The main Coolify project
- 🌐 Coolify Website - Official website and documentation
- 📚 Coolify Documentation - Complete documentation
- 💬 Coolify Discord - Community support
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
Built with ❤️ for the Coolify community
Powered by Coolify - An open-source & self-hostable Heroku / Netlify / Vercel alternative with 45.2k+ stars ⭐
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Tools
Enables AI assistants to interact with Coolify for complete infrastructure management including applications, databases, servers, deployments, and team operations. Provides 100% API coverage with 64 tools for managing the entire Coolify ecosystem through natural language.