History

dsarno 17c6a36c8d feat: Add beta server mode with PyPI pre-release support (#640 ) * feat: add TestPyPI toggle for pre-release server package testing - Add UseTestPyPI editor preference key - Add TestPyPI toggle to Advanced settings UI with tooltip - Configure uvx to use test.pypi.org when TestPyPI mode enabled - Skip version pinning in TestPyPI mode to get latest pre-release - Update ConfigJsonBuilder to handle TestPyPI index URL * Update .meta file * fix: Use PyPI pre-release versions instead of TestPyPI for beta server TestPyPI has polluted packages (broken httpx, mcp, fastapi) that cause server startup failures. Switch to publishing beta versions directly to PyPI as pre-releases (e.g., 9.3.0b20260127). Key changes: - beta-release.yml: Publish to PyPI instead of TestPyPI, use beta suffix - Use --prerelease explicit with version specifier (>=0.0.0a0) to only get prereleases of our package, not broken dependency prereleases - Default "Use Beta Server" toggle to true on beta branch - Rename UI label from "Use TestPyPI" to "Use Beta Server" - Add UseTestPyPI to EditorPrefsWindow known prefs - Add search field and refresh button to EditorPrefsWindow Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * feat: Add beta mode indicator to UI badge and server version logging - Show "β" suffix on version badge when beta server mode is enabled - Badge updates dynamically when toggle changes - Add server version to startup log: "MCP for Unity Server v9.2.0 starting up" - Add version field to /health endpoint response Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * refactor: Rename UseTestPyPI to UseBetaServer and fix EditorPrefs margin - Rename EditorPref key from UseTestPyPI to UseBetaServer for clarity - Rename all related variables and UXML element names - Increase bottom margin on EditorPrefs search bar to prevent clipping first entry Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * refactor: Address code review feedback - Centralize beta server uvx args in AssetPathUtility.GetBetaServerFromArgs() to avoid duplication between HTTP and stdio transports - Cache server version at startup instead of calling get_package_version() on every /health request - Add robustness to beta version parsing in workflow: strip existing pre-release suffix and validate X.Y.Z format before parsing Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> * Prioritize explicit fromUrl override and optimize search filter - GetBetaServerFromArgs/GetBetaServerFromArgsList now check for explicit GitUrlOverride before applying beta server mode, ensuring local dev paths and custom URLs are honored - EditorPrefsWindow search filter uses IndexOf with OrdinalIgnoreCase instead of ToLowerInvariant().Contains() for fewer allocations Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> --------- Co-authored-by: Marcus Sanatan <msanatan@gmail.com> Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>		2026-01-27 11:34:11 -08:00
..
Editor	feat: Add beta server mode with PyPI pre-release support (#640 )	2026-01-27 11:34:11 -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	Update the manual commands (#638 )	2026-01-26 23:32:20 -05: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 local Server folder (dev only; usually not needed when using uvx).
- 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