History

Marcus Sanatan 17cd543fab Fix stdio reloads (#402 ) * First pass at MCP client refactor * Restore original text instructions Well most of them, I modified a few * Move configurators to their own folder It's less clusterd * Remvoe override for Windsurf because we no longer need to use it * Add Antigravity configs Works like Windsurf, but it sucks ass * Add some docs for properties * Add comprehensive MCP client configurators documentation * Add missing imports (#7) * Handle Linux paths when unregistering CLI commands * Construct a JSON error in a much more secure fashion * Fix stdio auto-reconnect after domain reloads We mirror what we've done with the HTTP/websocket connection We also ensure the states from the stdio/HTTP connections are handled separately. Things now work as expected * Fix ActiveMode to return resolved transport mode instead of preferred mode The ActiveMode property now calls ResolvePreferredMode() to return the actual active transport mode rather than just the preferred mode setting. * Minor improvements for stdio bridge - Consolidated the !useHttp && isRunning checks into a single shouldResume flag. - Wrapped the fire-and-forget StopAsync in a continuation that logs faults (matching the HTTP handler pattern). - Wrapped StartAsync in a continuation that logs failures and only triggers the health check on success. * Refactor TransportManager to use switch expressions and improve error handling - Replace if-else chains with switch expressions for better readability and exhaustiveness checking - Add GetClient() helper method to centralize client retrieval logic - Wrap StopAsync in try-catch to log failures when stopping a failed transport - Use client.TransportName instead of mode.ToString() for consistent naming in error messages		2025-11-27 19:33:26 -04:00
..
Editor	Fix stdio reloads (#402 )	2025-11-27 19:33:26 -04:00
Runtime	Rename plugin folder to MCPForUnity (#303 )	2025-10-03 20:23:28 -04: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 8.0.1	2025-11-26 01:40:55 +00:00
package.json.meta	Rename plugin folder to MCPForUnity (#303 )	2025-10-03 20:23:28 -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