unreal-engine-mcp-server 0.5.4 → 0.5.6

package/.github/workflows/release.yml

@@ -1,112 +0,0 @@
-name: Create GitHub Release
-
-on:
-  push:
-    tags:
-      - 'v*.*.*'
-
-permissions:
-  contents: write
-
-jobs:
-  release:
-    name: Create Release
-    runs-on: ubuntu-latest
-    
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v6 # v4
-        with:
-          fetch-depth: 0
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v6 # v4
-        with:
-          node-version: '20'
-          cache: 'npm'
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Build package
-        run: npm run build
-
-      - name: Extract version from tag
-        id: version
-        run: |
-          VERSION=${GITHUB_REF#refs/tags/v}
-          echo "version=$VERSION" >> $GITHUB_OUTPUT
-          echo "tag=${GITHUB_REF#refs/tags/}" >> $GITHUB_OUTPUT
-          echo "Releasing version: $VERSION"
-
-      - name: Extract changelog for this version
-        id: changelog
-        run: |
-          VERSION=${{ steps.version.outputs.version }}
-          
-          CHANGELOG=$(awk -v ver="$VERSION" '
-            $0 ~ "## .*\\[" ver "\\]" { found=1; next }
-            found && /^## .*\[/ { exit }
-            found { print }
-          ' CHANGELOG.md)
-          
-          if [ -z "$CHANGELOG" ]; then
-            CHANGELOG="Release ${{ steps.version.outputs.tag }}"
-          fi
-          
-          echo "$CHANGELOG" > release_notes.md
-          echo "Generated release notes:"
-          cat release_notes.md
-
-      - name: Create dist archive
-        run: |
-          mkdir -p release-artifacts
-          
-          tar -czvf release-artifacts/unreal-engine-mcp-server-${{ steps.version.outputs.version }}.tar.gz \
-            dist/ \
-            package.json \
-            README.md \
-            CHANGELOG.md \
-            LICENSE
-          
-          zip -r release-artifacts/unreal-engine-mcp-server-${{ steps.version.outputs.version }}.zip \
-            dist/ \
-            package.json \
-            README.md \
-            CHANGELOG.md \
-            LICENSE
-
-      - name: Create Plugin archive
-        run: |
-          if [ -d "plugins/McpAutomationBridge" ]; then
-            tar -czvf release-artifacts/McpAutomationBridge-plugin-${{ steps.version.outputs.version }}.tar.gz \
-              plugins/McpAutomationBridge/
-            
-            zip -r release-artifacts/McpAutomationBridge-plugin-${{ steps.version.outputs.version }}.zip \
-              plugins/McpAutomationBridge/
-            
-            echo "Plugin archive created"
-          else
-            echo "Plugin directory not found, skipping plugin archive"
-          fi
-
-      - name: Create GitHub Release
-        uses: softprops/action-gh-release@a06a81a03ee405af7f2048a818ed3f03bbf83c7b # v2.5.0
-        with:
-          name: Release ${{ steps.version.outputs.tag }}
-          body_path: release_notes.md
-          draft: false
-          prerelease: ${{ contains(github.ref, 'alpha') || contains(github.ref, 'beta') || contains(github.ref, 'rc') }}
-          files: |
-            release-artifacts/*
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Release Summary
-        run: |
-          echo "## Release Created Successfully! 🎉" >> $GITHUB_STEP_SUMMARY
-          echo "" >> $GITHUB_STEP_SUMMARY
-          echo "**Version:** ${{ steps.version.outputs.tag }}" >> $GITHUB_STEP_SUMMARY
-          echo "" >> $GITHUB_STEP_SUMMARY
-          echo "### Artifacts:" >> $GITHUB_STEP_SUMMARY
-          ls -la release-artifacts/ >> $GITHUB_STEP_SUMMARY

package/.github/workflows/semantic-pull-request.yml

@@ -1,35 +0,0 @@
-name: "Semantic Pull Request"
-
-on:
-  pull_request_target:
-    types:
-      - opened
-      - edited
-      - synchronize
-
-permissions:
-  pull-requests: read
-  statuses: write
-
-jobs:
-  main:
-    name: Validate PR Title
-    runs-on: ubuntu-latest
-    steps:
-      - uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6.1.1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          types: |
-            feat
-            fix
-            docs
-            style
-            refactor
-            perf
-            test
-            build
-            ci
-            chore
-            revert
-          requireScope: false

package/.github/workflows/smoke-test.yml

@@ -1,36 +0,0 @@
-name: Smoke Test (Mock Mode)
-permissions:
-  contents: read
-
-on:
-  push:
-    branches: [ "main" ]
-  pull_request:
-    branches: [ "main" ]
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  smoke-test:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
-    
-    - name: Use Node.js
-      uses: actions/setup-node@395ad3262231945c25e8478fd5baf05154b1d79f # v6.1.0
-      with:
-        node-version: '20.x'
-        cache: 'npm'
-        
-    - name: Install dependencies
-      run: npm ci
-
-    - name: Build
-      run: npm run build
-
-    - name: Run Smoke Test
-      run: npm run test:smoke
-      env:
-        MOCK_UNREAL_CONNECTION: "true"

package/.github/workflows/stale.yml

@@ -1,28 +0,0 @@
-name: '🏷️ Stale Issue and PR Management'
-
-on:
-  schedule:
-    - cron: '0 0 * * *'
-  workflow_dispatch:
-
-permissions:
-  issues: write
-  pull-requests: write
-
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/stale@997185467fa4f803885201cee163a9f38240193d # v10.1.1
-        with:
-          stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions!'
-          stale-pr-message: 'This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Please update your PR or add a comment if you would like to keep it open.'
-          close-issue-message: 'This issue was closed because it has been stale for 14 days with no activity.'
-          close-pr-message: 'This pull request was closed because it has been stale for 14 days with no activity.'
-          days-before-stale: 60
-          days-before-close: 14
-          stale-issue-label: 'stale'
-          stale-pr-label: 'stale'
-          exempt-issue-labels: 'pinned,security,bug,enhancement'
-          exempt-pr-labels: 'pinned,security'
-          operations-per-run: 100

package/CONTRIBUTING.md

@@ -1,140 +0,0 @@
-# Contributing to Unreal Engine MCP Server
-
-Thank you for your interest in contributing! This document provides guidelines and instructions for contributing.
-
-## 📋 Table of Contents
-
-- [Code of Conduct](#code-of-conduct)
-- [Getting Started](#getting-started)
-- [Development Workflow](#development-workflow)
-- [Pull Request Process](#pull-request-process)
-- [Coding Standards](#coding-standards)
-
-## Code of Conduct
-
-Please be respectful and constructive in all interactions. We're building something together.
-
-## Getting Started
-
-### Prerequisites
-
-- **Node.js** 18+ 
-- **Unreal Engine** 5.0-5.7 (for live testing)
-- **Git**
-
-### Setup
-
-1. Fork and clone the repository:
-   ```bash
-   git clone https://github.com/ChiR24/Unreal_mcp.git
-   cd unreal-engine-mcp-server
-   ```
-
-2. Install dependencies:
-   ```bash
-   npm install
-   ```
-
-3. Build the project:
-   ```bash
-   npm run build
-   ```
-
-4. Run smoke tests (no Unreal needed):
-   ```bash
-   npm run test:smoke
-   ```
-
-## Development Workflow
-
-### Branch Naming
-
-Use descriptive branch names:
-- `feat/add-new-tool` - New features
-- `fix/connection-timeout` - Bug fixes
-- `docs/update-readme` - Documentation
-- `refactor/cleanup-bridge` - Code refactoring
-
-### Running Tests
-
-```bash
-# Smoke test (CI-compatible, no Unreal needed)
-npm run test:smoke
-
-# Live tests (requires Unreal Editor running with plugin)
-npm run test:all
-```
-
-### Building
-
-```bash
-npm run build        # Full build (TypeScript + WASM)
-npm run build:core   # TypeScript only
-npm run build:wasm   # WASM only (requires wasm-pack)
-```
-
-## Pull Request Process
-
-### Before Submitting
-
-1. ✅ Run `npm run lint` and fix any issues
-2. ✅ Run `npm run test:smoke` to verify basic functionality
-3. ✅ Update documentation if adding new features
-4. ✅ Update `CHANGELOG.md` under `[Unreleased]`
-
-### PR Title Format
-
-We use [Conventional Commits](https://www.conventionalcommits.org/). PR titles must follow this format:
-
-```
-<type>: <description>
-
-Examples:
-feat: add new animation blending tool
-fix: resolve WebSocket connection timeout
-docs: update installation instructions  
-refactor: simplify blueprint graph handler
-```
-
-**Types:** `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`
-
-### Review Process
-
-1. All PRs require at least one approval
-2. CI must pass (lint, smoke test, CodeQL)
-3. Maintainers may request changes
-
-## Coding Standards
-
-### TypeScript
-
-- Use strict TypeScript (`strict: true`)
-- Prefer `async/await` over raw Promises
-- Use descriptive variable names
-- Add JSDoc comments for public APIs
-
-### C++ (Plugin)
-
-- Follow Unreal Engine coding standards
-- Use `UPROPERTY`/`UFUNCTION` macros appropriately
-- Keep thread safety in mind for async operations
-
-### File Organization
-
-```
-src/
-├── tools/           # MCP tool implementations
-├── automation/      # Unreal bridge logic
-├── utils/           # Shared utilities
-└── services/        # Background services
-
-Plugins/
-└── McpAutomationBridge/  # C++ Unreal plugin
-```
-
-## Questions?
-
-- Open a [Discussion](../../discussions) for questions
-- Open an [Issue](../../issues) for bugs or feature requests
-
-Thank you for contributing! 🎮

package/Dockerfile

@@ -1,37 +0,0 @@
-# Multi-stage build for efficient image size
-FROM node:22-alpine AS builder
-
-# Set working directory
-WORKDIR /app
-
-# Copy package files
-COPY package*.json ./
-
-# Install ALL dependencies (including dev) for building - skip prepare script
-RUN npm ci --ignore-scripts
-
-# Copy TypeScript config and source files
-COPY tsconfig.json ./
-COPY src ./src
-
-# Build the TypeScript project
-RUN npm run build
-
-# Production stage
-FROM cgr.dev/chainguard/node:latest
-
-ENV NODE_ENV=production
-
-# Chainguard node runs as nonroot by default (user: node)
-WORKDIR /app
-
-# Copy only package manifests and install production deps in a clean layer
-COPY --chown=node:node package*.json ./
-RUN npm ci --omit=dev --ignore-scripts && npm cache clean --force
-
-# Copy built application from builder stage
-COPY --chown=node:node --from=builder /app/dist ./dist
-
-# No shell, no init needed; run as provided nonroot user
-ENTRYPOINT ["/usr/bin/node"]
-CMD ["dist/cli.js"]

package/GEMINI.md

@@ -1,115 +0,0 @@
-# Unreal Engine MCP Server
-
-## Project Overview
-
-The **Unreal Engine MCP Server** (`unreal-engine-mcp-server`) is a comprehensive Model Context Protocol (MCP) server that enables AI assistants to control Unreal Engine via a native automation bridge. It facilitates bidirectional communication between an AI agent (running via MCP) and an active Unreal Engine Editor session.
-
-### Architecture
-
-The system is composed of three main components:
-
-1.  **MCP Server (Node.js/TypeScript):**
-    *   **Role:** The core server that implements the MCP protocol, handles client requests, and orchestrates communication.
-    *   **Location:** `src/`
-    *   **Key File:** `src/index.ts` (Entry point), `src/unreal-bridge.ts` (Connection management).
-    *   **Tools:** Defines MCP tools for Actor manipulation, Asset management, Blueprints, etc. (found in `src/tools/`).
-
-2.  **Unreal Engine Plugin (C++):**
-    *   **Role:** Acts as the receiver and executor within the Unreal Engine process. It runs a WebSocket server to listen for commands from the Node.js server.
-    *   **Location:** `Plugins/McpAutomationBridge/`
-    *   **Key Functionality:** Handles `execute_console_command`, `set_object_property`, and other engine-level operations on the Game Thread.
-    *   **Communication:** Listens on `ws://localhost:8091` (default).
-
-3.  **WebAssembly Module (Rust):**
-    *   **Role:** Provides high-performance utilities for the Node.js server, such as complex property parsing and vector math.
-    *   **Location:** `wasm/`
-    *   **Key File:** `wasm/src/lib.rs`.
-
-## Building and Running
-
-### Prerequisites
-*   Node.js (v18 or higher)
-*   Unreal Engine (5.0-5.7)
-*   Rust (optional, if modifying WASM components)
-
-### Setup
-
-1.  **Install Dependencies:**
-    ```bash
-    npm install
-    ```
-
-2.  **Build the Server:**
-    ```bash
-    npm run build
-    ```
-
-3.  **Build WebAssembly (Optional):**
-    If you are working on the Rust module:
-    ```bash
-    npm run build:wasm
-    ```
-
-4.  **Unreal Plugin Installation:**
-    *   Copy the `Plugins/McpAutomationBridge` folder into your Unreal Project's `Plugins` directory (e.g., `YourProject/Plugins/`).
-    *   Regenerate project files and recompile your Unreal project.
-    *   Enable the plugin in the Unreal Editor if it's not automatically enabled.
-    *   Ensure the plugin is running (it should log "MCP Automation Bridge listening" to the Output Log).
-
-### Running the Server
-To start the MCP server:
-```bash
-npm start
-```
-Or for development with `ts-node`:
-```bash
-npm run dev
-```
-
-### Testing
-The project includes a suite of integration tests located in the `tests/` directory. These scripts act as "fake" MCP clients to verify functionality.
-
-*   **Run All Tests:**
-    ```bash
-    npm test
-    ```
-*   **Run Specific Test:**
-    ```bash
-    npm run test:control_actor
-    npm run test:manage_asset
-    npm run test:wasm
-    ```
-
-## Development Conventions
-
-*   **Language:**
-    *   Server logic is written in **TypeScript**.
-    *   Unreal integration is written in **C++**.
-    *   Performance modules are written in **Rust**.
-*   **Safety:**
-    *   The `UnrealBridge` class (`src/unreal-bridge.ts`) includes safety mechanisms like command throttling and "Safe ViewMode" switching to prevent crashing the engine with invalid commands.
-    *   **Do not** bypass these safety checks when adding new functionality.
-*   **Linting:**
-    *   TypeScript: `npm run lint`
-    *   C++/C#: Scripts provided (`npm run lint:cpp`, `npm run lint:csharp`) rely on external tools like `cpplint` and `dotnet-format`.
-
-## Directory Structure
-
-*   `src/`: Source code for the Node.js MCP server.
-    *   `tools/`: Definitions for MCP tools (Actors, Assets, etc.).
-    *   `resources/`: Definitions for MCP resources.
-    *   `wasm/`: Compiled WebAssembly bindings.
-*   `Plugins/`: Source code for the Unreal Engine C++ plugin.
-*   `wasm/`: Source code for the Rust WebAssembly module.
-*   `tests/`: Integration tests and test runners.
-*   `scripts/`: Utility scripts for build and maintenance.
-
-# Project Rules Agent
-
-- The user explicitly wants real, working code only. I must never add mocks, placeholders, false-passed success code, or any non-functional code. All solutions should be directly applicable to a live editor and pass all relevant tests genuinely.
-- The user explicitly requires real, working code only. I must never add mocks, placeholders, false-passed success codes, or any non-functional code. All solutions must be directly applicable to a live editor and pass all relevant tests genuinely.
-- Always read full file content.
-- Engine path: X:\Unreal_Engine\UE_5.0\Engine
-- Engine path: X:\Unreal_Engine\UE_5.6\Engine
-- Engine path: X:\Unreal_Engine\UE_5.7\Engine
-- Before editing codes in plugin make sure to check before in engine's code so that all code are correct.

package/claude_desktop_config_example.json

@@ -1,15 +0,0 @@
-{
-  "mcpServers": {
-    "unreal-engine": {
-      "command": "node",
-      "args": [
-        "PathToMCP\\UnrealMCP\\unreal-engine-mcp-server\\dist\\cli.js"
-      ],
-      "env": {
-        "UE_PROJECT_PATH": "C:/Users/YourName/Documents/Unreal Projects/YourProject",
-        "MCP_AUTOMATION_HOST": "127.0.0.1",
-        "MCP_AUTOMATION_PORT": "8091"
-      }
-    }
-  }
-}