Devpilot

🚀 MCP VPS 初始化工具

MCP VPS 初始化工具是一個基於模型上下文協議（MCP）的服務器，用於自動化 VPS 的初始化和管理。該工具藉助 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 連接

通過 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 初始化

使用系統更新和可選服務初始化全新的 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 設置

使用域名、反向代理和 SSL 證書配置 Nginx。 參數說明：

• domain（必填）：網站域名
• port（必填）：反向代理的後端端口
• ssl（選填）：使用 Certbot 啟用 SSL（默認：true）

示例：

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

4. GitHub CI/CD 設置

使用部署密鑰和自動化工作流設置 GitHub CI/CD。 參數說明：

• repoUrl（必填）：GitHub 倉庫 URL
• deployPath（必填）：服務器上的部署路徑

示例：

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

5. 執行命令

在已連接的 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 機密：添加到你的倉庫的 Actions 機密中
3. 工作流文件：添加到 .github/workflows/deploy.yml

生成的工作流將：

• 在推送到主分支時觸發
• 運行測試（如果有）
• 構建應用程序（如果存在構建腳本）
• 自動部署到你的 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 文件。