History

whatevertogo 300a745bf2 feat: Prefab Feature Updates (#611 ) * feat: Add prefab read operations (get_info, get_hierarchy, list_prefabs) - Add get_info: retrieve prefab metadata (GUID, type, components, child count, variant info) - Add get_hierarchy: get prefab internal structure with pagination support - Add list_prefabs: search prefabs in project with optional name filtering - Extract PrefabUtilityHelper class for reusable prefab utility methods - Update Python tool descriptions and parameter documentation Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: Use correct API to save prefab stage changes Replace PrefabUtility.SaveAsPrefabAsset (for creating new prefabs) with EditorSceneManager.SaveScene to properly save stage modifications. This fixes the issue where component additions were lost after closing the prefab stage. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * refactor: improve code quality and error handling - Add pagination constants (DefaultPageSize, MaxPageSize) - Extract SaveAndRefreshStage helper to reduce duplication - Change all user-facing messages to English - Add REQUIRED_PARAMS validation in Python - Split path parameter into prefab_path and folder_path for clarity - Improve error handling with specific exception types Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: Remove list_prefabs action and update related documentation * feat: Enhance prefab management with detailed parameter descriptions and new unlinking option * feat: Simplify prefab creation logic and unify logging for asset replacement * feat: Update SaveStagePrefab method to use SetDirty and SaveAssets for prefab stage saving * feat: Add PrefabUtilityHelper class with utility methods for prefab asset management * feat: Refactor action constants and enhance parameter validation in prefab management * feat: Update ValidateSourceObjectForPrefab method to remove replaceExisting parameter and simplify validation logic * fix: Fix searchInactive parameter and improve prefab management - Fix searchInactive not working correctly for child objects - Improve error message accuracy for object not found - Use Application.dataPath for reliable directory path resolution * feat: Add path validation and security checks for prefab operations * feat: Remove pagination from GetHierarchy method and simplify prefab retrieval * feat: Remove mode parameter from prefab management functions to simplify usage * fix: Improve path validation and replace logic in prefab management * feat: Enhance prefab management by adding nesting depth and parent prefab path retrieval * fix: resolve Unknown pseudo class last-child USS warnings Unity UI Toolkit does not support the :last-child pseudo-class. Replace it with a .section-last class that is applied programmatically to the last section in each .section-stack container. Also moves the Configure All Detected Clients button to the bottom of the Client Configuration section and makes it auto-width. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: improve prefab stage save for automated workflows - Add force parameter to save_open_stage for automated workflows where isDirty may not be correctly set - Use PrefabUtility.SaveAsPrefabAsset for dialog-free saving - Mark prefab stage scene dirty when modifying GameObjects in prefab mode - Skip save when no changes and force=false (prevents false dirty flag) The force parameter ensures reliable saving in CI/automation scenarios where Unity dirty tracking may be inconsistent with programmatic changes. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * Update prefab.py * refactor: remove unnecessary blank line before create function * feat: add info and hierarchy commands to prefab CLI for enhanced prefab management * feat: enhance prefab management with comprehensive CRUD tests and ensure dirty state tracking --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: David Sarno <david@lighthaus.us>		2026-01-25 16:36:29 -08:00
..
Editor	feat: Prefab Feature Updates (#611 )	2026-01-25 16:36:29 -08:00
Runtime	fix: improve manage_scene screenshot capture (#600 )	2026-01-24 17:07:08 -05:00
Editor.meta	Rename plugin folder to MCPForUnity (#303 )	2025-10-03 20:23:28 -04:00
README.md	HTTP Server, uvx, C# only custom tools (#375 )	2025-11-24 23:21:06 -04:00
README.md.meta	Rename plugin folder to MCPForUnity (#303 )	2025-10-03 20:23:28 -04:00
Runtime.meta	Rename plugin folder to MCPForUnity (#303 )	2025-10-03 20:23:28 -04:00
package.json	chore: bump version to 9.2.0	2026-01-23 05:34:19 +00:00
package.json.meta	Add .meta files (#472 )	2025-12-19 18:59:19 -04:00

README.md

MCP for Unity — Editor Plugin Guide

Use this guide to configure and run MCP for Unity inside the Unity Editor. Installation is covered elsewhere; this document focuses on the Editor window, client configuration, and troubleshooting.

Open the window

Unity menu: Window > MCP for Unity

The window has four areas: Server Status, Unity Bridge, MCP Client Configuration, and Script Validation.

Quick start

Open Window > MCP for Unity.
Click “Auto-Setup”.
If prompted:
- Select the packaged server folder (Server) if you want to run the bundled implementation.
- Install Python and/or uv/uvx if missing so the server can be managed locally.
- For Claude Code, ensure the claude CLI is installed.
Click “Start Bridge” if the Unity Bridge shows “Stopped”.
Use your MCP client (Cursor, VS Code, Windsurf, Claude Code) to connect.

Server Status

Status dot and label:
- Installed / Installed (Embedded) / Not Installed.
Mode and ports:
- Mode: Auto or Standard.
- Ports: Unity (varies; shown in UI), MCP 6500.
Actions:
- Auto-Setup: Registers/updates your selected MCP client(s), ensures bridge connectivity. Shows “Connected ✓” after success.
- Rebuild MCP Server: Rebuilds the Python based MCP server
- Select server folder…: Choose the folder containing server.py.
- Verify again: Re-checks server presence.
- If Python isn’t detected, use “Open Install Instructions”.
HTTP Server Command foldout:
- Expands to display the exact uvx command Unity will run.
- Includes a copy button and the “Start Local HTTP Server” action so you can launch or reuse the command elsewhere.

Unity Bridge

Shows Running or Stopped with a status dot.
Start/Stop Bridge button toggles the Unity bridge process used by MCP clients to talk to Unity.
Tip: After Auto-Setup, the bridge may auto-start in Auto mode.

MCP Client Configuration

Select Client: Choose your target MCP client (e.g., Cursor, VS Code, Windsurf, Claude Code).
Per-client actions:
- Cursor / VS Code / Windsurf:
  - Auto Configure: Writes/updates your config to launch the server via uvx with the current package version:
    - Command: uvx (or your overridden path)
    - Args: --from mcp-for-unity
  - Manual Setup: Opens a window with a pre-filled JSON snippet to copy/paste into your client config.
  - Choose UV Install Location: If uv/uvx isn’t on PATH, select the executable.
  - A compact “Config:” line shows the resolved config file name once uv/server are detected.
- Claude Code:
  - Register with Claude Code / Unregister MCP for Unity with Claude Code.
  - If the CLI isn’t found, click “Choose Claude Install Location”.
  - The window displays the resolved Claude CLI path when detected.

Notes:

The UI shows a status dot and a short status text (e.g., “Configured”, “uv Not Found”, “Claude Not Found”).
Use “Auto Configure” for one-click setup; use “Manual Setup” when you prefer to review/copy config.

Script Validation

Validation Level options:
- Basic — Only syntax checks
- Standard — Syntax + Unity practices
- Comprehensive — All checks + semantic analysis
- Strict — Full semantic validation (requires Roslyn)
Pick a level based on your project’s needs. A description is shown under the dropdown.

Troubleshooting

Python or uv not found:
- Help: Fix MCP for Unity with Cursor, VS Code & Windsurf
Claude CLI not found:
- Help: Fix MCP for Unity with Claude Code

Tips

Use Cmd+Shift+M (macOS) / Ctrl+Shift+M (Windows, Linux) to toggle the MCP for Unity window.
Enable “Show Debug Logs” in the header for more details in the Console when diagnosing issues.

README.md Unescape Escape