Coolify MCP

🚀 Coolify MCP サーバー

Coolify 用に実装された Model Context Protocol (MCP) サーバーです。これにより、AI アシスタントが自然言語であなたの Coolify インスタンスと対話できるようになります。

🚀 クイックスタート

Coolify MCP サーバーを使用することで、AI アシスタントが自然言語で Coolify インスタンスと対話できます。以下に具体的な使用方法を説明します。

✨ 主な機能

• AI アシスタントが自然言語で Coolify インスタンスと対話できる。
• サーバー管理、プロジェクト管理、アプリケーションとサービス管理、データベース管理、デプロイ管理などの多様な操作が可能。

💻 使用例

基本的な使用法

以下は、MCP 互換の AI アシスタントと対話するために使用できるサンプルのプロンプトです。

サーバー管理

# サーバーの一覧表示と確認
- 私のインスタンス内のすべての 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. 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
   

その他のツールでの設定

具体的なツールのドキュメントを参照して、適切な設定を行ってください。

📚 ドキュメント

ローカル設定

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 コミュニティに参加する。