Devpilot

🚀 MCP VPS Initialize

このツールは、自動的なVPSの初期化と管理を行うためのModel Context Protocol (MCP)サーバーです。SSHベースの自動化機能を提供し、新しいVPSインスタンスに一般的なサービスとCI/CDパイプラインをセットアップします。

✨ 主な機能

• 🔐 SSH認証：パスワードと秘密鍵の両方の認証方式をサポート
• 🛠️ VPS初期化：Node.js、PM2、Rust、Nginx、Redisの自動セットアップ
• 🌐 Nginx設定：リバースプロキシとSSL証明書を使用したドメイン設定
• 🚀 GitHub CI/CD：自動的なデプロイキーの生成とワークフローの作成
• 📝 包括的なロギング：Winstonベースの構造化ロギング
• 🔧 TypeScript：厳格なTypeScript設定で完全に型付けされています

📦 インストール

# リポジトリをクローン
git clone <repository-url>
cd mcp-vps-initialize

# 依存関係をインストール
npm install

# プロジェクトをビルド
npm run build

# サーバーを起動
npm start

💻 使用例

基本的な使用法

# 開発モードで実行
npm run dev

# コードのリント
npm run lint
npm run lint:fix

# コードのフォーマット
npm run format
npm run format:check

📚 ドキュメント

MCPツール

1. SSH Connect

パスワードまたは秘密鍵認証を使用してSSH経由でVPSに接続します。

パラメータ:

• host (必須): VPSのIPアドレスまたはホスト名
• username (必須): SSHユーザー名
• port (オプション): SSHポート (デフォルト: 22)
• password (オプション): SSHパスワード
• privateKeyPath (オプション): 秘密鍵ファイルのパス
• passphrase (オプション): 秘密鍵のパスフレーズ

例:

{
  "host": "192.168.1.100",
  "username": "root",
  "password": "your-password"
}

2. VPS Initialize

システムの更新とオプションのサービスを使用して新しいVPSを初期化します。

パラメータ:

• services (オプション): インストールするサービスを指定するオブジェクト
  • nodejs (ブール値): Node.js LTSをインストール
  • pm2 (ブール値): PM2プロセスマネージャーをインストール
  • rust (ブール値): Rustツールチェーンをインストール
  • nginx (ブール値): Nginxをインストールして設定
  • redis (ブール値): Redisをインストールして設定

例:

{
  "services": {
    "nodejs": true,
    "pm2": true,
    "nginx": true,
    "redis": false
  }
}

3. Nginx Setup

ドメイン、リバースプロキシ、およびSSL証明書を使用してNginxを設定します。

パラメータ:

• domain (必須): サイトのドメイン名
• port (必須): リクエストをプロキシするバックエンドポート
• ssl (オプション): Certbotを使用してSSLを有効にする (デフォルト: true)

例:

{
  "domain": "example.com",
  "port": 3000,
  "ssl": true
}

4. GitHub CI/CD Setup

デプロイキーと自動化されたワークフローを使用してGitHub CI/CDを設定します。

パラメータ:

• repoUrl (必須): GitHubリポジトリのURL
• deployPath (必須): サーバー上のデプロイパス

例:

{
  "repoUrl": "https://github.com/username/repo.git",
  "deployPath": "/opt/deployments/myapp"
}

5. Execute Command

接続されたVPS上で任意のコマンドを実行します。

パラメータ:

• command (必須): 実行するコマンド

例:

{
  "command": "systemctl status nginx"
}

ワークフロー

基本的なVPSセットアップ

1. VPSに接続する:

{
  "tool": "ssh_connect",
  "args": {
    "host": "your-vps-ip",
    "username": "root",
    "password": "your-password"
  }
}

2. VPSを初期化する:

{
  "tool": "vps_initialize",
  "args": {
    "services": {
      "nodejs": true,
      "pm2": true,
      "nginx": true
    }
  }
}

3. Nginxを設定する:

{
  "tool": "nginx_setup",
  "args": {
    "domain": "yourdomain.com",
    "port": 3000,
    "ssl": true
  }
}

4. CI/CDを設定する:

{
  "tool": "github_cicd_setup",
  "args": {
    "repoUrl": "https://github.com/username/repo.git",
    "deployPath": "/opt/deployments/myapp"
  }
}

GitHub CI/CDの手順

github_cicd_setupツールを実行した後、以下のものを受け取ります。

1. デプロイキー: GitHubリポジトリのデプロイキーに追加します。
2. GitHubシークレット: リポジトリのアクションシークレットに追加します。
3. ワークフローファイル: .github/workflows/deploy.ymlに追加します。

生成されたワークフローは以下のことを行います。

• main/masterブランチへのプッシュ時にトリガーされます。
• テストを実行します（利用可能な場合）。
• アプリケーションをビルドします（ビルドスクリプトが存在する場合）。
• 自動的にVPSにデプロイします。

セキュリティ機能

• ファイアウォール設定: 安全なデフォルト設定で自動的にUFWをセットアップします。
• SSL証明書: Let's Encrypt証明書の自動生成。
• SSHキー管理: 安全なデプロイキーの生成。
• プロセス分離: オプションでデプロイユーザーを作成します。

ロギング

ログは以下に書き込まれます。

• logs/combined.log: すべてのログレベル
• logs/error.log: エラーログのみ
• コンソール: 色付きのフォーマット出力

ログレベル: error, warn, info, debug

設定

サーバーは環境変数を通じて設定できます。

• LOG_LEVEL: ログレベルを設定します（デフォルト: 'info'）
• PORT: サーバーポート（スタンドアロンで実行する場合）

トラブルシューティング

一般的な問題

1. SSH接続失敗

• IPアドレスと資格情報を確認してください。
• ファイアウォール設定を確認してください。
• SSHサービスが実行中であることを確認してください。

2. SSL証明書の問題

• ドメインのDNSがサーバーを指していることを確認してください。
• ファイアウォールがHTTP/HTTPSを許可していることを確認してください。
• Let's Encryptのためのメールアドレスが有効であることを確認してください。

3. サービスのインストール失敗

• システムの更新状態を確認してください。
• インターネット接続を確認してください。
• エラーログを確認してください。

デバッグモード

デバッグロギングを有効にするには:

LOG_LEVEL=debug npm start

要件

• Node.js 18+
• 新しいUbuntu/Debian VPS
• ドメイン名（SSL設定用）
• GitHubリポジトリ（CI/CD用）

📄 ライセンス

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