Coolifymcp

CoolifyMCP

Coolify のすべての API エンドポイントに完全にアクセスできる、包括的な Model Context Protocol (MCP) サーバーです。CoolifyMCP を使うと、AI アシスタントが Coolify を操作し、アプリケーション、データベース、サーバー、デプロイなどを管理できます。

Coolify 向けに構築 — オープンソースでセルフホスト可能な Heroku／Netlify／Vercel の代替サービス

📖 目次

• 機能
• クイックスタート
• 前提条件
• インストール
• 設定
• 利用可能なツール
• 開発
• API カバレッジ
• 本番環境へのデプロイ
• ドキュメント
• コントリビューション
• ライセンス

✨ 機能

• 🎯 API カバレッジ 100%：すべての Coolify API エンドポイントを完全に実装
• 🛠️ 統合された MCP ツール 18 個：MCP プロトコルを通じて Coolify の機能に効率よくアクセス
• 🔒 型安全性：堅牢なエラー処理と開発体験を実現する TypeScript 製
• 🚀 本番環境対応：ヘルスチェック、適切なログ記録、監視機能
• 📦 モジュール型アーキテクチャ：関心事を分離した、クリーンで保守しやすいコードベース
• 🔧 包括的な機能：以下を含む Coolify のすべての機能に対応：
  • 👥 チームとプロジェクトの管理
  • 🚀 アプリケーションのライフサイクル管理
  • 🗄️ データベース管理（PostgreSQL、MySQL、MongoDB、Redis など）
  • 🖥️ サーバーの管理と検証
  • 🐳 サービス管理
  • 📦 デプロイ管理
  • 🔐 環境変数
  • 🔑 セキュリティキーの管理

🚀 クイックスタート

AI IDE にインストール

CoolifyMCP は、Model Context Protocol (MCP) に対応する主要な AI IDE で利用できます。お好みの IDE を選択してください。

Cursor IDE（推奨）

1. Cursor を開き、「Settings」→「Extensions」→「MCP」に移動します
2. 次の設定を ~/.cursor/mcp.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. Claude Desktop の設定を開きます
2. 次の設定を MCP 設定に追加します：

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

JetBrains AI Assistant

1. JetBrains IDE（IntelliJ、WebStorm など）を開きます
2. 「Settings」→「Tools」→「AI Assistant」→「Model Context Protocol (MCP)」に移動します
3. 「Add」をクリックして、次のように設定します：
   • 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

その他の MCP 対応 IDE

• LibreChat：設定で MCP サーバーの構成を追加します
• Klavis AI：お使いのプラットフォームの MCP 設定で構成します
• カスタム MCP クライアント：同じ設定形式を使用します

ローカル開発

# Clone and install
git clone https://github.com/howieduhzit/coolifymcp.git
cd coolifymcp
npm install
npm run build

# Run with environment variables
COOLIFY_API_TOKEN="your_token_here" COOLIFY_BASE_URL="https://your-coolify-instance.com/api/v1" npm start

📋 前提条件

• Node.js 20 以降 — ダウンロード
• npm 9 以降またはyarn — パッケージマネージャー
• Coolify API トークン — Coolify ダッシュボードから取得
• Coolify インスタンス URL — お使いの Coolify インスタンス（デフォルト：https://app.coolify.io/api/v1）

🛠️ インストール

NPM でのインストール（推奨）

1. npx でインストールして実行します（インストール不要）：

npx coolifymcp

2. または、グローバルにインストールします：

npm install -g coolifymcp
coolifymcp

ローカル開発

1. リポジトリをクローンします：

git clone https://github.com/howieduhzit/coolifymcp.git
cd coolifymcp

2. 依存関係をインストールします：

npm install

3. プロジェクトをビルドします：

npm run build

4. 環境変数を指定して実行します：

COOLIFY_API_TOKEN="your_token_here" COOLIFY_BASE_URL="https://your-coolify-instance.com/api/v1" npm start

⚙️ 設定

環境変数

変数	説明	必須	デフォルト
COOLIFY_API_TOKEN	Coolify API トークン	はい	-
COOLIFY_BASE_URL	Coolify API のベース URL	いいえ	https://app.coolify.io/api/v1
NODE_ENV	環境モード	いいえ	development
PORT	ヘルスチェックサーバーのポート	いいえ	3000

MCP クライアントの設定

設定形式は、すべての MCP 対応 IDE で共通です。一般的な設定場所は次のとおりです：

設定ファイルの場所：

• Cursor：~/.cursor/mcp.json
• Claude Desktop：アプリ内の MCP 設定
• JetBrains：設定 → ツール → AI Assistant → MCP
• LibreChat：設定 → MCP Servers
• カスタムクライアント：クライアントのドキュメントを参照してください

標準設定：

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

環境変数：

• COOLIFY_API_TOKEN（必須）：Coolify API トークン
• COOLIFY_BASE_URL（任意）：Coolify インスタンスの URL（デフォルトは https://app.coolify.io/api/v1）

🎯 利用可能なツール

Coolify MCP Server は、アクションベースのパラメーターを通じて Coolify のすべての機能をカバーする、18 個の統合ツールを提供します：

システム管理（1 ツール）

• coolify_system - システムのヘルス、バージョン、情報の管理
  • アクション：health、version、info

チーム管理（1 ツール）

• coolify_teams - チーム管理の全操作
  • アクション：list、current、get、members

プロジェクト管理（2 ツール）

• coolify_projects - プロジェクトの CRUD 操作
  • アクション：list、create、get、update、delete
• coolify_project_environments - プロジェクト環境の管理
  • アクション：list、create、get、delete

アプリケーション管理（5 ツール）

• coolify_applications - アプリケーションの CRUD 操作（すべての種類）
  • アクション：list、create、update、get、delete
  • 対応形式：public、private_github、private_deploy_key、dockerfile、dockerimage、dockercompose
• coolify_application_lifecycle - アプリケーションのライフサイクル管理
  • アクション：start、stop、restart
• coolify_application_envs - アプリケーションの環境変数
  • アクション：list、create、bulk_update、delete
• coolify_logs - アプリケーションログの取得
  • アクション：get
• coolify_application_deployments - アプリケーションのデプロイ管理
  • アクション：list、get、trigger

データベース管理（3 ツール）

• coolify_databases - データベースの CRUD 操作
  • アクション：list、create、get、update、delete
• coolify_database_lifecycle - データベースのライフサイクル管理
  • アクション：start、stop、restart
• coolify_database_types - 特定のデータベースタイプの作成
  • アクション：create（PostgreSQL、MySQL、MongoDB、Redis）

サーバー管理（2 ツール）

• coolify_servers - サーバーの CRUD 操作
  • アクション：list、create、get、update、delete
• coolify_server_management - サーバーの操作とリソース
  • アクション：validate、domains、resources

サービス管理（3 ツール）

• coolify_services - サービスの CRUD 操作
  • アクション：list、create、get、update、delete
• coolify_service_lifecycle - サービスのライフサイクル管理
  • アクション：start、stop、restart
• coolify_service_envs - サービスの環境変数
  • アクション：list、create、update、bulk_update、delete

セキュリティ管理（1 ツール）

• coolify_security_keys - セキュリティキーの管理
  • アクション：list、create、get、update、delete

🏗️ 開発

スクリプト

• npm run build - TypeScript を JavaScript にビルド
• npm start - 本番サーバーを起動
• npm run dev - ホットリロード対応の開発サーバーを起動

プロジェクト構成

coolify-mcp-server/
├── src/
│   └── index.ts          # Main MCP server implementation
├── dist/                 # Compiled JavaScript output
├── Dockerfile           # Docker configuration
├── docker-compose.yaml  # Docker Compose configuration
├── package.json         # Dependencies and scripts
├── tsconfig.json        # TypeScript configuration
├── config.example.env   # Environment variables template
└── README.md           # This file

🔧 API カバレッジ

この MCP サーバーは、18 個の統合ツールで83 以上の API エンドポイントをカバーし、Coolify API を100％カバーしています。

• ✅ システム管理（1 ツール） - ヘルス、バージョン、システム情報
• ✅ チーム管理（1 ツール） - チームに関するすべての操作
• ✅ プロジェクト管理（2 ツール） - プロジェクトと環境
• ✅ アプリケーション管理（5 ツール） - すべてのアプリケーションタイプとライフサイクル
• ✅ データベース管理（3 ツール） - すべてのデータベースタイプと操作
• ✅ サーバー管理（2 ツール） - サーバーの操作とリソース
• ✅ サービス管理（3 ツール） - サービスの操作とライフサイクル
• ✅ セキュリティ管理（1 ツール） - セキュリティキーと認証

統合による主なメリット：

• 🎯 複雑さの軽減：83 個以上の個別ツールではなく、18 個のツール
• 🚀 パフォーマンスの向上：ツール定義を減らし、API をよりシンプルに
• 🔧 メンテナンスの容易化：整理しやすいアクションベースのパラメーター
• 📚 ドキュメントの簡素化：明確なツールカテゴリとアクション

🚀 本番環境へのデプロイ

ヘルスチェック

本番モード（NODE_ENV=production）で実行している場合、サーバーには /health のヘルスチェックエンドポイントが含まれます。

環境設定

本番環境にデプロイする際は、次の点を確認してください。

1. NODE_ENV=production を設定する
2. 有効な COOLIFY_API_TOKEN を指定する
3. 正しい COOLIFY_BASE_URL を設定する
4. 適切なロギングを設定する
5. 監視とアラートを設定する

📝 ライセンス

MIT ライセンス - 詳細は LICENSE ファイルを参照してください。

🤝 コントリビューション

1. リポジトリをフォークする
2. フィーチャーブランチを作成する
3. 変更を加える
4. 該当する場合はテストを追加する
5. プルリクエストを送信する

📚 ドキュメント

• README.md - 完全なドキュメントと使用例
• GitHub リポジトリ - ソースコードと課題の追跡

📞 サポート

問題や質問がある場合：

• 📝 リポジトリで課題を作成してください
• 📖 Coolify のドキュメントを確認してください
• 💬 Coolify コミュニティに参加してください

🙏 謝辞

このプロジェクトは、セルフホスト型アプリケーションを驚くほど簡単に実現する素晴らしいオープンソースプラットフォーム、Coolifyのために構築され、Coolify によって支えられています。このような強力なツールを作り上げた Coolify チームとコミュニティに、心より感謝します。

• 🌟 GitHub の Coolify - Coolify のメインプロジェクト
• 🌐 Coolify のウェブサイト - 公式ウェブサイトとドキュメント
• 📚 Coolify のドキュメント - 完全なドキュメント
• 💬 Coolify Discord - コミュニティサポート

📄 ライセンス

このプロジェクトは MIT ライセンスの下で提供されています。詳細は LICENSE ファイルを参照してください。

---

Coolify コミュニティのために ❤️ を込めて開発

---

Coolify によって提供 - 45.2k 以上のスター ⭐ を獲得した、Heroku／Netlify／Vercel に代わるオープンソースでセルフホスト可能なプラットフォーム