mlgym-deploy 3.3.0 → 3.3.1

package/index.js

@@ -17,7 +17,7 @@ import crypto from 'crypto';
 const execAsync = promisify(exec);
 
 // Current version of this MCP server - INCREMENT FOR WORKFLOW FIXES
-const CURRENT_VERSION = '3.3.0';  // Added 6 new tools: health check, domain, deployment commands, manual deploy, options, rollback
+const CURRENT_VERSION = '3.3.1';  // Updated help with plain English examples showing what users say vs tool calls
 const PACKAGE_NAME = 'mlgym-deploy';
 
 // Debug logging configuration - ENABLED BY DEFAULT
@@ -2833,127 +2833,186 @@ async function showHelp(args) {
 ║            Complete Deployment Platform for GitLab + Coolify          ║
 ╚═══════════════════════════════════════════════════════════════════════╝
 
+HOW TO USE THIS GUIDE:
+Users speak in plain English. When they say "deploy to mlgym" or "show me
+the status", the AI translates this to the appropriate tool call.
+
+Examples show both what users say AND the tool call that gets executed.
+
 📦 DEPLOYMENT TOOLS
 ───────────────────────────────────────────────────────────────────────
 
-🚀 mlgym_deploy
-   Complete deployment workflow - auth, analyze, create repo, and deploy in one call.
+🚀 mlgym_deploy - Deploy your application
+   What users say:
+     • "Deploy to mlgym"
+     • "Deploy this project to mlgym"
+     • "I want to deploy my app"
+     • "Push this to production"
 
-   Usage:
+   Tool call:
      mlgym_deploy({
        project_name: "my-app",
        project_description: "My application",
-       email: "user@example.com",     // optional if already authenticated
-       password: "password123"         // optional if already authenticated
+       email: "user@example.com",     // optional if already logged in
+       password: "password123"         // optional if already logged in
      })
 
-📊 mlgym_status
-   Check authentication status and project configuration.
+📊 mlgym_status - Check deployment status
+   What users say:
+     • "Show me the status"
+     • "What's deployed?"
+     • "Am I logged in?"
+     • "Check if my project is configured"
 
-   Usage:
-     mlgym_status({local_path: "."})
+   Tool call:
+     mlgym_status({
+       local_path: "."                // optional, defaults to current directory
+     })
 
-📝 mlgym_deploy_logs
-   View deployment history and build logs.
+📝 mlgym_deploy_logs - View deployment logs
+   What users say:
+     • "Show me the deployment logs"
+     • "What happened in the last deployment?"
+     • "Why did my deployment fail?"
+     • "Show the build logs"
 
-   Usage:
+   Tool call:
      mlgym_deploy_logs({
        project_name: "my-app",
-       depth: 3                        // number of deployments to retrieve
+       depth: 3                        // optional, number of recent deployments
      })
 
 ⚙️  CONFIGURATION TOOLS
 ───────────────────────────────────────────────────────────────────────
 
-🔧 mlgym_set_env_vars
-   Set environment variables (DATABASE_URL, API keys, etc.)
+🔧 mlgym_set_env_vars - Set environment variables
+   What users say:
+     • "Set the database URL"
+     • "Add these environment variables"
+     • "Configure my API keys"
+     • "I need to set DATABASE_URL and STRIPE_KEY"
 
-   Usage:
+   Tool call:
      mlgym_set_env_vars({
        project_name: "my-app",
        variables: {
-         DATABASE_URL: "postgresql://...",
-         API_KEY: "secret123"
+         DATABASE_URL: "postgresql://user:pass@host:5432/db",
+         STRIPE_KEY: "sk_live_123...",
+         NODE_ENV: "production"
        }
      })
 
-❤️  mlgym_set_health_check
-   Configure health checks to monitor application availability.
+❤️  mlgym_set_health_check - Configure health monitoring
+   What users say:
+     • "Set up a health check"
+     • "Monitor my /health endpoint"
+     • "Check if my app is alive every 30 seconds"
+     • "Enable health checks on /api/health"
 
-   Usage:
+   Tool call:
      mlgym_set_health_check({
        project_name: "my-app",
        enabled: true,
-       path: "/health",
-       method: "GET",
-       return_code: 200,
-       interval: 5
+       path: "/health",               // endpoint to check
+       method: "GET",                  // HTTP method
+       return_code: 200,               // expected status code
+       interval: 30                    // check every 30 seconds
      })
 
-🌐 mlgym_set_domain
-   Set custom domain/FQDN for your application.
+🌐 mlgym_set_domain - Set custom domain
+   What users say:
+     • "Use my custom domain"
+     • "Point myapp.com to this deployment"
+     • "Set the domain to app.example.com"
+     • "Change the URL to www.mysite.com"
 
-   Usage:
+   Tool call:
      mlgym_set_domain({
        project_name: "my-app",
-       domain: "myapp.example.com"
+       domain: "myapp.example.com"     // your custom domain
      })
 
-📜 mlgym_set_deployment_commands
-   Configure pre-deployment and post-deployment commands.
+📜 mlgym_set_deployment_commands - Configure build commands
+   What users say:
+     • "Run migrations before deploying"
+     • "Seed the database after deployment"
+     • "Execute npm run build before starting"
+     • "Run these commands during deployment"
 
-   Usage:
+   Tool call:
      mlgym_set_deployment_commands({
        project_name: "my-app",
-       pre_command: "npm run migrate",
-       post_command: "npm run seed"
+       pre_command: "npm run migrate",  // runs before deployment
+       post_command: "npm run seed"     // runs after deployment
      })
 
-⚙️  mlgym_set_options
-   Configure application options (build cache, etc.)
+⚙️  mlgym_set_options - Configure deployment options
+   What users say:
+     • "Disable build cache"
+     • "Turn off the build cache"
+     • "Don't use cached builds"
+     • "Force a fresh build"
 
-   Usage:
+   Tool call:
      mlgym_set_options({
        project_name: "my-app",
-       disable_build_cache: true
+       disable_build_cache: true        // force fresh builds
      })
 
 🎬 DEPLOYMENT MANAGEMENT
 ───────────────────────────────────────────────────────────────────────
 
-▶️  mlgym_deploy_manual
-   Manually trigger a new deployment.
+▶️  mlgym_deploy_manual - Trigger deployment manually
+   What users say:
+     • "Deploy now"
+     • "Trigger a deployment"
+     • "Redeploy my application"
+     • "Start a new deployment"
 
-   Usage:
-     mlgym_deploy_manual({project_name: "my-app"})
+   Tool call:
+     mlgym_deploy_manual({
+       project_name: "my-app"
+     })
 
-⏪ mlgym_rollback
-   Rollback to previous deployment.
+⏪ mlgym_rollback - Rollback to previous version
+   What users say:
+     • "Rollback my deployment"
+     • "Go back to the previous version"
+     • "Undo the last deployment"
+     • "Revert to deployment #123"
 
-   Usage:
+   Tool call:
      mlgym_rollback({
        project_name: "my-app",
-       deployment_id: 123              // optional, uses previous if not specified
+       deployment_id: 123              // optional, uses previous if omitted
      })
 
 👤 USER MANAGEMENT
 ───────────────────────────────────────────────────────────────────────
 
-➕ mlgym_user_create
-   Create a new MLGym user account.
+➕ mlgym_user_create - Create new account
+   What users say:
+     • "Create a new account"
+     • "Sign me up"
+     • "Register a new user"
+     • "I need an account"
 
-   Usage:
+   Tool call:
      mlgym_user_create({
        email: "user@example.com",
        name: "John Doe",
        password: "SecurePass123!",
-       accept_terms: true
+       accept_terms: true               // must be true
      })
 
-🔐 mlgym_auth_login
-   Login with existing credentials.
+🔐 mlgym_auth_login - Login to existing account
+   What users say:
+     • "Login"
+     • "Log me in"
+     • "Authenticate with my credentials"
+     • "Sign in to my account"
 
-   Usage:
+   Tool call:
      mlgym_auth_login({
        email: "user@example.com",
        password: "SecurePass123!"
@@ -2962,17 +3021,25 @@ async function showHelp(args) {
 ❓ HELP
 ───────────────────────────────────────────────────────────────────────
 
-📖 mlgym_help
-   Display this help message.
+📖 mlgym_help - Display this help
+   What users say:
+     • "Help"
+     • "Show me what I can do"
+     • "What commands are available?"
+     • "How do I use mlgym?"
 
-   Usage:
+   Tool call:
      mlgym_help()
 
 ╔═══════════════════════════════════════════════════════════════════════╗
-║                         WORKFLOW EXAMPLES                             ║
+║                    COMMON WORKFLOW EXAMPLES                           ║
 ╚═══════════════════════════════════════════════════════════════════════╝
 
-1️⃣  Complete New Deployment:
+1️⃣  First Time User - Complete Deployment:
+
+   User: "Deploy to mlgym"
+
+   AI executes:
    mlgym_deploy({
      project_name: "my-app",
      project_description: "My new app",
@@ -2981,22 +3048,79 @@ async function showHelp(args) {
    })
 
 2️⃣  Set Environment Variables:
+
+   User: "Set the database URL for my app"
+
+   AI executes:
    mlgym_set_env_vars({
      project_name: "my-app",
-     variables: {DATABASE_URL: "..."}
+     variables: {
+       DATABASE_URL: "postgresql://user:pass@host:5432/db"
+     }
    })
 
-3️⃣  Configure & Deploy:
-   mlgym_set_health_check({project_name: "my-app", enabled: true})
-   mlgym_set_domain({project_name: "my-app", domain: "app.example.com"})
-   mlgym_deploy_manual({project_name: "my-app"})
+3️⃣  Configure Health Check:
+
+   User: "Monitor my /health endpoint every 30 seconds"
+
+   AI executes:
+   mlgym_set_health_check({
+     project_name: "my-app",
+     enabled: true,
+     path: "/health",
+     interval: 30
+   })
+
+4️⃣  Set Custom Domain:
+
+   User: "Point myapp.com to this deployment"
+
+   AI executes:
+   mlgym_set_domain({
+     project_name: "my-app",
+     domain: "myapp.com"
+   })
+
+5️⃣  Manually Trigger Deployment:
+
+   User: "Deploy now"
+
+   AI executes:
+   mlgym_deploy_manual({
+     project_name: "my-app"
+   })
+
+6️⃣  Check Deployment Logs:
+
+   User: "Show me the last 5 deployments"
+
+   AI executes:
+   mlgym_deploy_logs({
+     project_name: "my-app",
+     depth: 5
+   })
+
+7️⃣  Rollback if Something Breaks:
+
+   User: "Rollback to the previous version"
+
+   AI executes:
+   mlgym_rollback({
+     project_name: "my-app"
+   })
+
+╔═══════════════════════════════════════════════════════════════════════╗
+║                            QUICK TIPS                                 ║
+╚═══════════════════════════════════════════════════════════════════════╝
 
-4️⃣  Monitor & Rollback if needed:
-   mlgym_deploy_logs({project_name: "my-app", depth: 5})
-   mlgym_rollback({project_name: "my-app"})
+💡 Users speak naturally - AI translates to tool calls
+💡 Authentication is cached - login once, deploy many times
+💡 All tools work with project_name to identify the application
+💡 Most parameters are optional with sensible defaults
 
-📚 More info: https://backend.eu.ezb.net
-🐛 Issues: Report via user dashboard
+📚 Documentation: https://mlgym.info
+🌐 Backend: https://backend.eu.ezb.net
+📊 Dashboard: https://platform.mlgym.info
 `;
 
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mlgym-deploy",
-  "version": "3.3.0",
+  "version": "3.3.1",
   "description": "MCP server for MLGym - Complete deployment management: deploy, configure, monitor, and rollback applications",
   "main": "index.js",
   "type": "module",