unreal-engine-mcp-server 0.5.4 → 0.5.5

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"
-      }
-    }
-  }
-}

package/dist/types/responses.d.ts

@@ -1,249 +0,0 @@
-export interface BaseResponse {
-    success: boolean;
-    message?: string;
-    error?: string;
-    errorCode?: string;
-}
-export interface Vector3 {
-    x: number;
-    y: number;
-    z: number;
-}
-export interface Rotator {
-    pitch: number;
-    yaw: number;
-    roll: number;
-}
-export interface Transform {
-    location?: Vector3;
-    rotation?: Rotator;
-    scale?: Vector3;
-}
-export interface SpawnActorResponse extends BaseResponse {
-    actorName?: string;
-    actorPath?: string;
-    classPath?: string;
-}
-export interface DeleteActorResponse extends BaseResponse {
-    deletedCount?: number;
-    deletedActors?: string[];
-}
-export interface GetTransformResponse extends BaseResponse {
-    location?: Vector3;
-    rotation?: Rotator;
-    scale?: Vector3;
-}
-export interface SetTransformResponse extends BaseResponse {
-    actorName?: string;
-}
-export interface FindActorsResponse extends BaseResponse {
-    actors?: Array<{
-        name: string;
-        label?: string;
-        class?: string;
-        path?: string;
-    }>;
-    count?: number;
-}
-export interface GetComponentsResponse extends BaseResponse {
-    components?: Array<{
-        name: string;
-        type: string;
-        properties?: Record<string, unknown>;
-    }>;
-}
-export interface ApplyForceResponse extends BaseResponse {
-    actorName?: string;
-    forceApplied?: Vector3;
-}
-export interface AssetInfo {
-    name: string;
-    path: string;
-    class?: string;
-    packagePath?: string;
-    size?: number;
-}
-export interface ListAssetsResponse extends BaseResponse {
-    assets?: AssetInfo[];
-    count?: number;
-    directory?: string;
-}
-export interface CreateAssetResponse extends BaseResponse {
-    assetPath?: string;
-    assetName?: string;
-}
-export interface DeleteAssetResponse extends BaseResponse {
-    deletedPath?: string;
-    deletedCount?: number;
-}
-export interface GetDependenciesResponse extends BaseResponse {
-    dependencies?: string[];
-    referencers?: string[];
-    count?: number;
-}
-export interface AssetExistsResponse extends BaseResponse {
-    exists?: boolean;
-    assetPath?: string;
-}
-export interface CreateBlueprintResponse extends BaseResponse {
-    blueprintPath?: string;
-    blueprintName?: string;
-    parentClass?: string;
-}
-export interface GetBlueprintResponse extends BaseResponse {
-    path?: string;
-    name?: string;
-    parentClass?: string;
-    variables?: Array<{
-        name: string;
-        type: string;
-        defaultValue?: unknown;
-    }>;
-    functions?: Array<{
-        name: string;
-        parameters?: Array<{
-            name: string;
-            type: string;
-        }>;
-        returnType?: string;
-    }>;
-    components?: Array<{
-        name: string;
-        type: string;
-        properties?: Record<string, unknown>;
-    }>;
-}
-export interface AddVariableResponse extends BaseResponse {
-    variableName?: string;
-    variableType?: string;
-}
-export interface CreateNodeResponse extends BaseResponse {
-    nodeId?: string;
-    nodeName?: string;
-}
-export interface ConnectPinsResponse extends BaseResponse {
-    connected?: boolean;
-    fromNode?: string;
-    toNode?: string;
-}
-export interface LoadLevelResponse extends BaseResponse {
-    levelPath?: string;
-    levelName?: string;
-}
-export interface SaveLevelResponse extends BaseResponse {
-    savedPath?: string;
-}
-export interface ListLevelsResponse extends BaseResponse {
-    levels?: Array<{
-        name: string;
-        path: string;
-        isLoaded?: boolean;
-        isVisible?: boolean;
-    }>;
-}
-export interface BuildLightingResponse extends BaseResponse {
-    quality?: string;
-    buildTime?: number;
-}
-export interface PlayInEditorResponse extends BaseResponse {
-    isPlaying?: boolean;
-    isPaused?: boolean;
-}
-export interface SetCameraResponse extends BaseResponse {
-    location?: Vector3;
-    rotation?: Rotator;
-    fov?: number;
-}
-export interface ScreenshotResponse extends BaseResponse {
-    filePath?: string;
-    width?: number;
-    height?: number;
-}
-export interface ViewModeResponse extends BaseResponse {
-    viewMode?: string;
-}
-export interface CreateSequenceResponse extends BaseResponse {
-    sequencePath?: string;
-    sequenceName?: string;
-}
-export interface AddActorToSequenceResponse extends BaseResponse {
-    bindingId?: string;
-    actorName?: string;
-}
-export interface AddKeyframeResponse extends BaseResponse {
-    frameNumber?: number;
-    property?: string;
-    value?: unknown;
-}
-export interface PlaySoundResponse extends BaseResponse {
-    soundPath?: string;
-    audioComponentId?: string;
-}
-export interface CreateSoundCueResponse extends BaseResponse {
-    cuePath?: string;
-    cueName?: string;
-}
-export interface SpawnEffectResponse extends BaseResponse {
-    effectName?: string;
-    effectPath?: string;
-    location?: Vector3;
-}
-export interface CreateNiagaraSystemResponse extends BaseResponse {
-    systemPath?: string;
-    systemName?: string;
-}
-export interface SpawnLightResponse extends BaseResponse {
-    lightName?: string;
-    lightType?: string;
-    location?: Vector3;
-}
-export interface SetupGIResponse extends BaseResponse {
-    method?: string;
-    bounces?: number;
-}
-export interface CreateAnimBlueprintResponse extends BaseResponse {
-    blueprintPath?: string;
-    skeletonPath?: string;
-}
-export interface PlayMontageResponse extends BaseResponse {
-    montagePath?: string;
-    playRate?: number;
-}
-export interface ConsoleCommandResponse extends BaseResponse {
-    command?: string;
-    output?: string;
-}
-export interface ProfileResponse extends BaseResponse {
-    profileType?: string;
-    enabled?: boolean;
-}
-export interface SetCVarResponse extends BaseResponse {
-    cvarName?: string;
-    value?: string;
-}
-export interface InspectObjectResponse extends BaseResponse {
-    objectPath?: string;
-    className?: string;
-    properties?: Record<string, unknown>;
-}
-export interface GetPropertyResponse extends BaseResponse {
-    propertyName?: string;
-    value?: unknown;
-    propertyType?: string;
-}
-export interface SetPropertyResponse extends BaseResponse {
-    propertyName?: string;
-    newValue?: unknown;
-}
-export interface CreateLandscapeResponse extends BaseResponse {
-    landscapeName?: string;
-    componentCount?: {
-        x: number;
-        y: number;
-    };
-}
-export interface AddFoliageResponse extends BaseResponse {
-    foliageType?: string;
-    instanceCount?: number;
-}
-//# sourceMappingURL=responses.d.ts.map

package/dist/types/responses.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=responses.js.map