unreal-engine-mcp-server 0.4.3 → 0.4.5

package/eslint.config.mjs

@@ -0,0 +1,68 @@
+import js from '@eslint/js';
+import tseslintPlugin from '@typescript-eslint/eslint-plugin';
+import tsParser from '@typescript-eslint/parser';
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+const tsRecommendedConfigs = tseslintPlugin.configs['flat/recommended'].map((config) => ({
+  ...config,
+  languageOptions: {
+    ...config.languageOptions,
+    parser: tsParser,
+    parserOptions: {
+      ...(config.languageOptions?.parserOptions ?? {}),
+      ecmaVersion: 2022,
+      sourceType: 'module',
+      tsconfigRootDir: __dirname,
+    },
+  },
+}));
+
+export default [
+  {
+    ignores: [
+      'dist/**',
+      'node_modules/**',
+      '**/*.js',
+      '**/*.d.ts',
+      '**/*.cjs',
+      '**/*.mjs',
+      'eslint.config.*',
+      'vitest.config.ts',
+      'test-*.js',
+      'tests/**/*.mjs',
+    ],
+  },
+  js.configs.recommended,
+  ...tsRecommendedConfigs,
+  {
+    files: ['**/*.ts'],
+    rules: {
+      '@typescript-eslint/no-unused-vars': [
+        'warn',
+        {
+          args: 'all',
+          argsIgnorePattern: '^_',
+          caughtErrors: 'all',
+          caughtErrorsIgnorePattern: '^_',
+          destructuredArrayIgnorePattern: '^_',
+          varsIgnorePattern: '^_',
+          ignoreRestSiblings: true,
+        },
+      ],
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/explicit-module-boundary-types': 'off',
+      '@typescript-eslint/no-non-null-assertion': 'warn',
+      'no-console': 'off',
+      semi: ['error', 'always'],
+      quotes: ['error', 'single', { avoidEscape: true }],
+      'no-empty': ['error', { allowEmptyCatch: true }],
+      'no-useless-escape': 'warn',
+      'no-case-declarations': 'off',
+      'prefer-const': 'warn',
+      'no-unused-vars': 'off',
+    },
+  },
+];

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "unreal-engine-mcp-server",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "mcpName": "io.github.ChiR24/unreal-engine-mcp",
-  "description": "Production-ready MCP server for Unreal Engine integration with 13 tools",
+  "description": "A comprehensive Model Context Protocol (MCP) server that enables AI assistants to control Unreal Engine via Remote Control API. Built with TypeScript and designed for game development automation.",
   "type": "module",
+  "module": "src/index.ts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {
@@ -11,13 +12,19 @@
   },
   "scripts": {
     "build": "tsc -p tsconfig.json",
-    "start": "node dist/index.js",
-    "dev": "ts-node-esm src/index.ts",
+    "build:watch": "tsc -p tsconfig.json --watch",
+  "start": "node dist/cli.js",
+    "smithery:dev": "npx @smithery/cli dev",
+    "smithery:build": "npx @smithery/cli build",
+  "smithery:ci": "npm run build && npx @smithery/cli build",
+  "dev": "ts-node-esm src/cli.ts",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
     "clean": "rimraf dist",
     "prepare": "npm run build",
-    "test:tools": "node tests/run-unreal-tool-tests.mjs"
+    "test:tools": "node tests/run-unreal-tool-tests.mjs",
+    "type-check": "tsc --noEmit",
+    "prebuild": "npm run clean"
   },
   "engines": {
     "node": ">=18"
@@ -35,7 +42,8 @@
   "author": "Unreal Engine MCP Team",
   "license": "MIT",
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.18.2",
+    "@modelcontextprotocol/sdk": "^1.19.1",
+    "zod": "^3.22.2",
     "ajv": "^8.17.1",
     "axios": "^1.12.2",
     "dotenv": "^16.4.5",
@@ -47,9 +55,10 @@
     "@types/json5": "^0.0.30",
     "@types/node": "^20.12.7",
     "@types/ws": "^8.5.10",
-    "@typescript-eslint/eslint-plugin": "^8.43.0",
-    "@typescript-eslint/parser": "^8.43.0",
-    "eslint": "^8.57.0",
+  "@typescript-eslint/eslint-plugin": "^8.44.1",
+  "@typescript-eslint/parser": "^8.44.1",
+    "eslint": "^9.36.0",
+    "@smithery/cli": "^1.0.0",
     "rimraf": "^6.0.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"

package/server.json

@@ -2,13 +2,13 @@
   "$schema": "https://static.modelcontextprotocol.io/schemas/2025-09-16/server.schema.json",
   "name": "io.github.ChiR24/unreal-engine-mcp",
   "description": "MCP server for Unreal Engine 5 with 13 tools for game development automation.",
-  "version": "0.4.3",
+  "version": "0.4.5",
   "packages": [
     {
       "registryType": "npm",
       "registryBaseUrl": "https://registry.npmjs.org",
       "identifier": "unreal-engine-mcp-server",
-      "version": "0.4.3",
+      "version": "0.4.5",
       "transport": {
         "type": "stdio"
       },
@@ -36,6 +36,12 @@
           "description": "Logging level: debug, info, warn, error (default: info)",
           "isRequired": false,
           "value": "info"
+        },
+        {
+          "name": "UE_PROJECT_PATH",
+          "description": "Absolute path to your Unreal .uproject file",
+          "isRequired": false,
+          "value": "C:/Users/YourName/Documents/Unreal Projects/YourProject"
         }
       ]
     }

package/smithery.yaml

@@ -0,0 +1,29 @@
+name: "Unreal Engine MCP"
+description: "A comprehensive Model Context Protocol (MCP) server that enables AI assistants to control Unreal Engine via Remote Control API. Built with TypeScript and designed for game development automation."
+runtime: "typescript"
+env:
+  NODE_ENV: "production"
+  LOG_LEVEL: "info"
+  UE_PROJECT_PATH: "C:/Users/YourName/Documents/Unreal Projects/YourProject"
+# Session configuration hints (served by the exported Zod configSchema in src/index.ts)
+sessionConfig:
+  ueHost:
+    type: string
+    description: "Unreal Engine host (e.g., 127.0.0.1)"
+    default: "127.0.0.1"
+  ueHttpPort:
+    type: number
+    description: "Remote Control HTTP port"
+    default: 30010
+  ueWsPort:
+    type: number
+    description: "Remote Control WS port"
+    default: 30011
+  logLevel:
+    type: string
+    description: "Server log verbosity"
+    default: "info"
+  projectPath:
+    type: string
+    description: "Absolute path to your .uproject file"
+    default: "C:/Users/YourName/Documents/Unreal Projects/YourProject"

package/src/index.ts

@@ -40,10 +40,11 @@ import {
   GetPromptRequestSchema
 } from '@modelcontextprotocol/sdk/types.js';
 import { responseValidator } from './utils/response-validator.js';
-import { ErrorHandler } from './utils/error-handler.js';
+import { z } from 'zod';
 import { routeStdoutLogsToStderr } from './utils/stdio-redirect.js';
-import { cleanObject } from './utils/safe-json.js';
 import { createElicitationHelper } from './utils/elicitation.js';
+import { cleanObject } from './utils/safe-json.js';
+import { ErrorHandler } from './utils/error-handler.js';
 
 const log = new Logger('UE-MCP');
 
@@ -87,7 +88,7 @@ const CONFIG = {
   RETRY_DELAY_MS: 2000,
   // Server info
   SERVER_NAME: 'unreal-engine-mcp',
-  SERVER_VERSION: '0.4.3',
+  SERVER_VERSION: '0.4.5',
   // Monitoring
   HEALTH_CHECK_INTERVAL_MS: 30000 // 30 seconds
 };
@@ -143,7 +144,7 @@ async function performHealthCheck(bridge: UnrealBridge): Promise<boolean> {
   }
 }
 
-export async function createServer() {
+export function createServer() {
   const bridge = new UnrealBridge();
   // Disable auto-reconnect loops; connect only on-demand
   bridge.setAutoReconnectEnabled(false);
@@ -249,8 +250,7 @@ export async function createServer() {
         prompts: {
           listChanged: false
         },
-        logging: {},
-        elicitation: {}
+        logging: {}
       }
     }
   );
@@ -677,8 +677,37 @@ export async function createServer() {
   return { server, bridge };
 }
 
+// Export configuration schema for Smithery session UI and validation
+export const configSchema = z.object({
+  ueHost: z.string().optional().default('127.0.0.1').describe('Unreal Engine host (e.g. 127.0.0.1)'),
+  ueHttpPort: z.number().int().optional().default(30010).describe('Remote Control HTTP port'),
+  ueWsPort: z.number().int().optional().default(30020).describe('Remote Control WebSocket port'),
+  logLevel: z.enum(['debug', 'info', 'warn', 'error']).optional().default('info').describe('Runtime log level'),
+  projectPath: z.string().optional().default('C:/Users/YourName/Documents/Unreal Projects/YourProject').describe('Absolute path to your Unreal .uproject file')
+});
+
+// Default export expected by Smithery TypeScript runtime. Accepts an optional config object
+// and injects values into the environment before creating the server.
+export default function createServerDefault({ config }: { config?: any } = {}) {
+  try {
+    if (config) {
+      if (typeof config.ueHost === 'string' && config.ueHost.trim()) process.env.UE_HOST = config.ueHost;
+      if (config.ueHttpPort !== undefined) process.env.UE_RC_HTTP_PORT = String(config.ueHttpPort);
+      if (config.ueWsPort !== undefined) process.env.UE_RC_WS_PORT = String(config.ueWsPort);
+  if (typeof config.logLevel === 'string') process.env.LOG_LEVEL = config.logLevel;
+  if (typeof config.projectPath === 'string' && config.projectPath.trim()) process.env.UE_PROJECT_PATH = config.projectPath;
+    }
+  } catch (e) {
+    // Non-fatal: log and continue (console to avoid circular logger dependencies at top-level)
+    console.debug('[createServerDefault] Failed to apply config to environment:', (e as any)?.message || e);
+  }
+
+  const { server } = createServer();
+  return server;
+}
+
 export async function startStdioServer() {
-  const { server } = await createServer();
+  const { server } = createServer();
   const transport = new StdioServerTransport();
   
   // Add debugging for transport messages
@@ -695,10 +724,4 @@ export async function startStdioServer() {
   log.info('Unreal Engine MCP Server started on stdio');
 }
 
-// Start the server when run directly
-if (import.meta.url === `file://${process.argv[1].replace(/\\/g, '/')}`) {
-  startStdioServer().catch(error => {
-    console.error('Failed to start server:', error);
-    process.exit(1);
-  });
-}
+// Direct execution is handled via src/cli.ts to keep this module side-effect free.