Skip to main content

Install

Three install paths are supported. Pick one. Git URL is the fastest if you just want to try it.

Prerequisites​

Option 1 — Git URL (fastest)​

This path needs git on your PATH (the Package Manager runs it). If it reports Error when executing git command, see troubleshooting.

In Unity, open Window → Package Manager, click the + button, choose Add package from git URL..., and paste:

https://github.com/CoplayDev/unity-mcp.git?path=/MCPForUnity#main

For the latest beta features, use the beta branch:

https://github.com/CoplayDev/unity-mcp.git?path=/MCPForUnity#beta

Option 2 — Unity Asset Store​

  1. Visit MCP for Unity on the Asset Store.
  2. Click Add to My Assets.
  3. Import via Window → Package Manager → My Assets.

Option 3 — OpenUPM​

openupm add com.coplaydev.unity-mcp

Start the server and connect​

After import, MCP for Unity opens a setup wizard automatically.

  1. Confirm Python and uv are installed — the wizard guides you through both if missing.
  2. Click Done. Once dependencies are green, a list of MCP clients detected on your machine appears.
  3. Pick the clients you want to configure and click Configure Selected.

You can return to this UI anytime via Window → MCP for Unity to start/stop the server, switch transport (HTTP vs stdio), or reconfigure clients. The status panel reads Connected when everything is wired up.

First prompt​

Try one of these in your MCP client:

Create a red, blue, and yellow cube in the current scene.

Build a simple player controller with WASD movement and a double-jump.

List every script in Assets/Scripts and tell me which ones reference Rigidbody.

Per-client notes​

  • Claude Desktop only supports stdio. MCP for Unity will silently configure it that way even if you have HTTP selected elsewhere.
  • Cursor, Antigravity, OpenClaw still require enabling an MCP toggle or plugin in their own settings after auto-configuration.
  • OpenClaw also needs the openclaw-mcp-bridge plugin enabled and follows the currently selected MCP for Unity transport.
  • Claude Code, VS Code, Windsurf, Cline, and the CLI clients auto-connect after configuration.

Detailed per-client setup lives in the MCP Client Configurators guide.

Manual MCP client configuration​

If auto-configuration doesn't work for your client, add this to your client's MCP config file:

HTTP (default — Cursor, Windsurf, Antigravity, VS Code, Cline, etc.)​

{
  "mcpServers": {
    "unityMCP": {
      "url": "http://localhost:8080/mcp"
    }
  }
}

VS Code​

{
  "servers": {
    "unityMCP": {
      "type": "http",
      "url": "http://localhost:8080/mcp"
    }
  }
}

Stdio (Claude Desktop, or any client without HTTP)​

macOS / Linux:

{
  "mcpServers": {
    "unityMCP": {
      "command": "uvx",
      "args": ["--from", "mcpforunityserver", "mcp-for-unity", "--transport", "stdio"]
    }
  }
}

Windows:

{
  "mcpServers": {
    "unityMCP": {
      "command": "C:/Users/YOUR_USERNAME/AppData/Local/Microsoft/WinGet/Links/uvx.exe",
      "args": ["--from", "mcpforunityserver", "mcp-for-unity", "--transport", "stdio"]
    }
  }
}

Troubleshooting​

  • Unity Bridge not connecting — Open Window → MCP for Unity and check the status panel. Restart Unity if needed.
  • Server not starting — Verify uv --version works in your terminal. Check the MCP for Unity log for errors.
  • Client not connecting — Confirm the HTTP server is running on localhost:8080 and the URL in your client config matches.

For Cursor / VS Code / Windsurf and Claude Code troubleshooting, see the GitHub Wiki (migrating into this site).

Still stuck? Open an issue or join Discord.