unreal-engine-mcp-server 0.2.1 → 0.3.1

package/src/index.ts

@@ -43,7 +43,7 @@ import {
 import { responseValidator } from './utils/response-validator.js';
 import { ErrorHandler } from './utils/error-handler.js';
 import { routeStdoutLogsToStderr } from './utils/stdio-redirect.js';
-import { sanitizeResponse, cleanObject } from './utils/safe-json.js';
+import { cleanObject } from './utils/safe-json.js';
 
 const log = new Logger('UE-MCP');
 
@@ -75,16 +75,20 @@ const metrics: PerformanceMetrics = {
   recentErrors: []
 };
 
+// Health check timer and last success tracking (stop pings after inactivity)
+let healthCheckTimer: NodeJS.Timeout | undefined;
+let lastHealthSuccessAt = 0;
+
 // Configuration
 const CONFIG = {
-  // Tool mode: true = consolidated (10 tools), false = individual (36+ tools)
+  // Tool mode: true = consolidated (13 tools), false = individual (36+ tools)
   USE_CONSOLIDATED_TOOLS: process.env.USE_CONSOLIDATED_TOOLS !== 'false',
   // Connection retry settings
   MAX_RETRY_ATTEMPTS: 3,
   RETRY_DELAY_MS: 2000,
   // Server info
   SERVER_NAME: 'unreal-engine-mcp',
-  SERVER_VERSION: '0.2.1',
+  SERVER_VERSION: '0.3.1',
   // Monitoring
   HEALTH_CHECK_INTERVAL_MS: 30000 // 30 seconds
 };
@@ -111,11 +115,16 @@ function trackPerformance(startTime: number, success: boolean) {
 
 // Health check function
 async function performHealthCheck(bridge: UnrealBridge): Promise<boolean> {
+  // If not connected, do not attempt any ping (stay quiet)
+  if (!bridge.isConnected) {
+    return false;
+  }
   try {
     // Use a safe echo command that doesn't affect any settings
     await bridge.executeConsoleCommand('echo MCP Server Health Check');
     metrics.connectionStatus = 'connected';
     metrics.lastHealthCheck = new Date();
+    lastHealthSuccessAt = Date.now();
     return true;
   } catch (err1) {
     // Fallback: minimal Python ping (if Python plugin is enabled)
@@ -123,11 +132,13 @@ async function performHealthCheck(bridge: UnrealBridge): Promise<boolean> {
       await bridge.executePython("import sys; sys.stdout.write('OK')");
       metrics.connectionStatus = 'connected';
       metrics.lastHealthCheck = new Date();
+      lastHealthSuccessAt = Date.now();
       return true;
     } catch (err2) {
       metrics.connectionStatus = 'error';
       metrics.lastHealthCheck = new Date();
-      log.warn('Health check failed (console and python):', err1, err2);
+      // Avoid noisy warnings when engine may be shutting down; log at debug
+      log.debug('Health check failed (console and python):', err1, err2);
       return false;
     }
   }
@@ -135,50 +146,68 @@ async function performHealthCheck(bridge: UnrealBridge): Promise<boolean> {
 
 export async function createServer() {
   const bridge = new UnrealBridge();
+  // Disable auto-reconnect loops; connect only on-demand
+  bridge.setAutoReconnectEnabled(false);
   
   // Initialize response validation with schemas
-  log.info('Initializing response validation...');
+  log.debug('Initializing response validation...');
   const toolDefs = CONFIG.USE_CONSOLIDATED_TOOLS ? consolidatedToolDefinitions : toolDefinitions;
   toolDefs.forEach((tool: any) => {
     if (tool.outputSchema) {
       responseValidator.registerSchema(tool.name, tool.outputSchema);
     }
   });
-  log.info(`Registered ${responseValidator.getStats().totalSchemas} output schemas for validation`);
-  
-  // Connect to UE5 Remote Control with retries and timeout
-  const connected = await bridge.tryConnect(
-    CONFIG.MAX_RETRY_ATTEMPTS,
-    5000, // 5 second timeout per attempt
-    CONFIG.RETRY_DELAY_MS
-  );
-  
-  if (connected) {
-    metrics.connectionStatus = 'connected';
-    log.info('Successfully connected to Unreal Engine');
-  } else {
-    log.warn('Could not connect to Unreal Engine after retries');
-    log.info('Server will start anyway - connection will be retried periodically');
-    log.info('Make sure Unreal Engine is running with Remote Control enabled');
-    metrics.connectionStatus = 'disconnected';
-    
-    // Schedule automatic reconnection attempts
-    setInterval(async () => {
+  // Summary at debug level to avoid repeated noisy blocks in some shells
+  log.debug(`Registered ${responseValidator.getStats().totalSchemas} output schemas for validation`);
+
+  // Do NOT connect to Unreal at startup; connect on demand
+  log.debug('Server starting without connecting to Unreal Engine');
+  metrics.connectionStatus = 'disconnected';
+
+  // Health checks manager (only active when connected)
+  const startHealthChecks = () => {
+    if (healthCheckTimer) return;
+    lastHealthSuccessAt = Date.now();
+    healthCheckTimer = setInterval(async () => {
+      // Only attempt health pings while connected; stay silent otherwise
       if (!bridge.isConnected) {
-        log.info('Attempting to reconnect to Unreal Engine...');
-        const reconnected = await bridge.tryConnect(1, 5000, 0); // Single attempt
-        if (reconnected) {
-          log.info('Reconnected to Unreal Engine successfully');
-          metrics.connectionStatus = 'connected';
+        // Optionally pause fully after 5 minutes of no success
+        const FIVE_MIN_MS = 5 * 60 * 1000;
+        if (!lastHealthSuccessAt || Date.now() - lastHealthSuccessAt > FIVE_MIN_MS) {
+          if (healthCheckTimer) {
+            clearInterval(healthCheckTimer);
+            healthCheckTimer = undefined;
+          }
+          log.info('Health checks paused after 5 minutes without a successful response');
         }
+        return;
       }
-    }, 10000); // Try every 10 seconds
-  }
-  
-  // Start periodic health checks
-  setInterval(() => {
-    performHealthCheck(bridge);
-  }, CONFIG.HEALTH_CHECK_INTERVAL_MS);
+
+      await performHealthCheck(bridge);
+      // Stop sending echoes if we haven't had a successful response in > 5 minutes
+      const FIVE_MIN_MS = 5 * 60 * 1000;
+      if (!lastHealthSuccessAt || Date.now() - lastHealthSuccessAt > FIVE_MIN_MS) {
+        if (healthCheckTimer) {
+          clearInterval(healthCheckTimer);
+          healthCheckTimer = undefined;
+          log.info('Health checks paused after 5 minutes without a successful response');
+        }
+      }
+    }, CONFIG.HEALTH_CHECK_INTERVAL_MS);
+  };
+
+  // On-demand connection helper
+  const ensureConnectedOnDemand = async (): Promise<boolean> => {
+    if (bridge.isConnected) return true;
+    const ok = await bridge.tryConnect(3, 5000, 1000);
+    if (ok) {
+      metrics.connectionStatus = 'connected';
+      startHealthChecks();
+    } else {
+      metrics.connectionStatus = 'disconnected';
+    }
+    return ok;
+  };
 
   // Resources
   const assetResources = new AssetResources(bridge);
@@ -272,6 +301,10 @@ export async function createServer() {
     const uri = request.params.uri;
     
     if (uri === 'ue://assets') {
+      const ok = await ensureConnectedOnDemand();
+      if (!ok) {
+        return { contents: [{ uri, mimeType: 'text/plain', text: 'Unreal Engine not connected (after 3 attempts).' }] };
+      }
       const list = await assetResources.list('/Game', true);
       return {
         contents: [{
@@ -283,6 +316,10 @@ export async function createServer() {
     }
     
     if (uri === 'ue://actors') {
+      const ok = await ensureConnectedOnDemand();
+      if (!ok) {
+        return { contents: [{ uri, mimeType: 'text/plain', text: 'Unreal Engine not connected (after 3 attempts).' }] };
+      }
       const list = await actorResources.listActors();
       return {
         contents: [{
@@ -294,6 +331,10 @@ export async function createServer() {
     }
     
     if (uri === 'ue://level') {
+      const ok = await ensureConnectedOnDemand();
+      if (!ok) {
+        return { contents: [{ uri, mimeType: 'text/plain', text: 'Unreal Engine not connected (after 3 attempts).' }] };
+      }
       const level = await levelResources.getCurrentLevel();
       return {
         contents: [{
@@ -305,6 +346,10 @@ export async function createServer() {
     }
     
     if (uri === 'ue://exposed') {
+      const ok = await ensureConnectedOnDemand();
+      if (!ok) {
+        return { contents: [{ uri, mimeType: 'text/plain', text: 'Unreal Engine not connected (after 3 attempts).' }] };
+      }
       try {
         const exposed = await bridge.getExposed();
         return {
@@ -327,11 +372,13 @@ export async function createServer() {
     
     if (uri === 'ue://health') {
       const uptimeMs = Date.now() - metrics.uptime;
-      // Query engine version and feature flags (best-effort)
+      // Query engine version and feature flags only when connected
       let versionInfo: any = {};
       let featureFlags: any = {};
-      try { versionInfo = await bridge.getEngineVersion(); } catch {}
-      try { featureFlags = await bridge.getFeatureFlags(); } catch {}
+      if (bridge.isConnected) {
+        try { versionInfo = await bridge.getEngineVersion(); } catch {}
+        try { featureFlags = await bridge.getFeatureFlags(); } catch {}
+      }
       const health = {
         status: metrics.connectionStatus,
         uptime: Math.floor(uptimeMs / 1000),
@@ -369,6 +416,10 @@ export async function createServer() {
     }
 
     if (uri === 'ue://version') {
+      const ok = await ensureConnectedOnDemand();
+      if (!ok) {
+        return { contents: [{ uri, mimeType: 'text/plain', text: 'Unreal Engine not connected (after 3 attempts).' }] };
+      }
       const info = await bridge.getEngineVersion();
       return {
         contents: [{
@@ -382,7 +433,7 @@ export async function createServer() {
     throw new Error(`Unknown resource: ${uri}`);
   });
 
-  // Handle tool listing - switch between consolidated (10) or individual (36) tools
+  // Handle tool listing - switch between consolidated (13) or individual (36) tools
   server.setRequestHandler(ListToolsRequestSchema, async () => {
     log.info(`Serving ${CONFIG.USE_CONSOLIDATED_TOOLS ? 'consolidated' : 'individual'} tools`);
     return {
@@ -390,10 +441,24 @@ export async function createServer() {
     };
   });
 
-  // Handle tool calls - switch between consolidated (10) or individual (36) tools
+  // Handle tool calls - switch between consolidated (13) or individual (36) tools
   server.setRequestHandler(CallToolRequestSchema, async (request) => {
     const { name, arguments: args } = request.params;
     const startTime = Date.now();
+
+    // Ensure connection only when needed, with 3 attempts
+    const connected = await ensureConnectedOnDemand();
+    if (!connected) {
+      const notConnected = {
+        content: [{ type: 'text', text: 'Unreal Engine is not connected (after 3 attempts). Please open UE and try again.' }],
+        success: false,
+        error: 'UE_NOT_CONNECTED',
+        retriable: false,
+        scope: `tool-call/${name}`
+      } as any;
+      trackPerformance(startTime, false);
+      return notConnected;
+    }
     
     // Create tools object for handler
     const tools = {

package/src/resources/actors.ts

@@ -34,25 +34,63 @@ export class ActorResources {
     // Use Python to get actors via EditorActorSubsystem
     try {
       const pythonCode = `
-import unreal
+import unreal, json
 actor_subsystem = unreal.get_editor_subsystem(unreal.EditorActorSubsystem)
-actors = actor_subsystem.get_all_level_actors()
+actors = actor_subsystem.get_all_level_actors() if actor_subsystem else []
 actor_list = []
 for actor in actors:
-    if actor:
-        actor_list.append({
-            'name': actor.get_name(),
-            'class': actor.get_class().get_name(),
-            'path': actor.get_path_name()
-        })
-print(f"Found {len(actor_list)} actors")
+    try:
+        if actor:
+            actor_list.append({
+                'name': actor.get_name(),
+                'class': actor.get_class().get_name(),
+                'path': actor.get_path_name()
+            })
+    except Exception:
+        pass
+print('RESULT:' + json.dumps({'success': True, 'count': len(actor_list), 'actors': actor_list}))
       `.trim();
       
-      const result = await this.bridge.executePython(pythonCode);
-      this.setCache('listActors', result);
-      return result;
+      const resp = await this.bridge.executePythonWithResult(pythonCode);
+      if (resp && typeof resp === 'object' && resp.success === true && Array.isArray((resp as any).actors)) {
+        this.setCache('listActors', resp);
+        return resp;
+      }
+
+      // Fallback manual extraction with bracket matching
+      const raw = await this.bridge.executePython(pythonCode);
+      let output = '';
+      if (raw?.LogOutput && Array.isArray(raw.LogOutput)) output = raw.LogOutput.map((l: any) => l.Output || '').join('');
+      else if (typeof raw === 'string') output = raw; else output = JSON.stringify(raw);
+      const marker = 'RESULT:';
+      const idx = output.lastIndexOf(marker);
+      if (idx !== -1) {
+        let i = idx + marker.length;
+        while (i < output.length && output[i] !== '{') i++;
+        if (i < output.length) {
+          let depth = 0, inStr = false, esc = false, j = i;
+          for (; j < output.length; j++) {
+            const ch = output[j];
+            if (esc) { esc = false; continue; }
+            if (ch === '\\') { esc = true; continue; }
+            if (ch === '"') { inStr = !inStr; continue; }
+            if (!inStr) {
+              if (ch === '{') depth++;
+              else if (ch === '}') { depth--; if (depth === 0) { j++; break; } }
+            }
+          }
+          const jsonStr = output.slice(i, j);
+          try {
+            const parsed = JSON.parse(jsonStr);
+            this.setCache('listActors', parsed);
+            return parsed;
+          } catch {}
+        }
+      }
+
+      return { success: false, error: 'Failed to parse actors list' };
     } catch (err) {
-      return { error: `Failed to list actors: ${err}` };
+      return { success: false, error: `Failed to list actors: ${err}` };
     }
   }
 

package/src/resources/assets.ts

@@ -10,10 +10,10 @@ export class AssetResources {
     return page !== undefined ? `${dir}::${recursive ? 1 : 0}::${page}` : `${dir}::${recursive ? 1 : 0}`; 
   }
 
-  async list(dir = '/Game', recursive = false, limit = 50) {
+  async list(dir = '/Game', _recursive = false, limit = 50) {
     // ALWAYS use non-recursive listing to show only immediate children
     // This prevents timeouts and makes navigation clearer
-    recursive = false; // Force non-recursive
+    _recursive = false; // Force non-recursive
     
     // Cache fast-path
     try {
@@ -105,7 +105,7 @@ export class AssetResources {
    * Directory-based listing for paths with too many assets
    * Shows only immediate children (folders and files) to avoid timeouts
    */
-  private async listDirectoryOnly(dir: string, recursive: boolean, limit: number) {
+  private async listDirectoryOnly(dir: string, _recursive: boolean, limit: number) {
     // Always return only immediate children to avoid timeout and improve navigation
     try {
       const py = `