This release is a pre-release and may not be stable for production use.
MCP for Unity Server
Model Context Protocol server for Unity Editor integration. Control Unity through natural language using AI assistants like Claude, Cursor, and more.
Maintained by Coplay - This project is not affiliated with Unity Technologies.
💬 Join our community: Discord Server
Required: Install the Unity MCP Plugin to connect Unity Editor with this MCP server. You also need uvx (requires uv) to run the server.
Installation
Option 1: PyPI
Install and run directly from PyPI using uvx.
Run Server (HTTP):
uvx --from mcpforunityserver mcp-for-unity --transport http --http-url http://localhost:8080
MCP Client Configuration (HTTP):
{
"mcpServers": {
"UnityMCP": {
"url": "http://localhost:8080/mcp"
}
}
}
MCP Client Configuration (stdio):
{
"mcpServers": {
"UnityMCP": {
"command": "uvx",
"args": [
"--from",
"mcpforunityserver",
"mcp-for-unity",
"--transport",
"stdio"
]
}
}
}
Option 2: From GitHub Source
Use this to run the latest released version from the repository. Change the version to main to run the latest unreleased changes from the repository.
{
"mcpServers": {
"UnityMCP": {
"command": "uvx",
"args": [
"--from",
"git+https://github.com/CoplayDev/unity-mcp@v9.6.8#subdirectory=Server",
"mcp-for-unity",
"--transport",
"stdio"
]
}
}
}
Option 3: Docker
Use Pre-built Image:
docker run -p 8080:8080 msanatan/mcp-for-unity-server:latest --transport http --http-url http://0.0.0.0:8080
Build Locally:
docker build -t unity-mcp-server .
docker run -p 8080:8080 unity-mcp-server --transport http --http-url http://0.0.0.0:8080
Configure your MCP client with "url": "http://localhost:8080/mcp".
Option 4: Local Development
For contributing or modifying the server code:
# Clone the repository
git clone https://github.com/CoplayDev/unity-mcp.git
cd unity-mcp/Server
# Run with uv
uv run src/main.py --transport stdio
Configuration
The server connects to Unity Editor automatically when both are running. Most users do not need to change any settings.
CLI options
These options apply to the mcp-for-unity command (whether run via uvx, Docker, or python src/main.py).
--transport {stdio,http}- Transport protocol (default:stdio)--http-url URL- Base URL used to derive host/port defaults (default:http://localhost:8080)--http-host HOST- Override HTTP bind host (overrides URL host)--http-port PORT- Override HTTP bind port (overrides URL port)--http-remote-hosted- Treat HTTP transport as remotely hosted- Requires API key authentication (see below)
- Disables local/CLI-only HTTP routes (
/api/command,/api/instances,/api/custom-tools) - Forces explicit Unity instance selection for MCP tool/resource calls
- Isolates Unity sessions per user
--api-key-validation-url URL- External endpoint to validate API keys (required when--http-remote-hostedis set)--api-key-login-url URL- URL where users can obtain/manage API keys (served by/api/auth/login-url)--api-key-cache-ttl SECONDS- Cache duration for validated keys (default:300)--api-key-service-token-header HEADER- Header name for server-to-auth-service authentication (e.g.X-Service-Token)--api-key-service-token TOKEN- Token value sent to the auth service for server authentication--default-instance INSTANCE- Default Unity instance to target (project name, hash, orName@hash)--project-scoped-tools- Keep custom tools scoped to the active Unity project and enable the custom tools resource--unity-instance-token TOKEN- Optional per-launch token set by Unity for deterministic lifecycle management--pidfile PATH- Optional path where the server writes its PID on startup (used by Unity-managed terminal launches)
Environment variables
UNITY_MCP_TRANSPORT- Transport protocol:stdioorhttpUNITY_MCP_HTTP_URL- HTTP server URL (default:http://localhost:8080)UNITY_MCP_HTTP_HOST- HTTP bind host (overrides URL host)UNITY_MCP_HTTP_PORT- HTTP bind port (overrides URL port)UNITY_MCP_HTTP_REMOTE_HOSTED- Enable remote-hosted mode (true,1, oryes)UNITY_MCP_DEFAULT_INSTANCE- Default Unity instance to target (project name, hash, orName@hash)UNITY_MCP_SKIP_STARTUP_CONNECT=1- Skip initial Unity connection attempt on startupUNITY_MCP_LOG_DIR- Override the rotating server log directory. Default:%LOCALAPPDATA%\UnityMCP\Logs(Windows),~/Library/Application Support/UnityMCP/Logs(macOS),$XDG_STATE_HOME/UnityMCP/Logs(Linux/BSD, defaults to~/.local/state/UnityMCP/Logs).
API key authentication (remote-hosted mode):
UNITY_MCP_API_KEY_VALIDATION_URL- External endpoint to validate API keysUNITY_MCP_API_KEY_LOGIN_URL- URL where users can obtain/manage API keysUNITY_MCP_API_KEY_CACHE_TTL- Cache TTL for validated keys in seconds (default:300)UNITY_MCP_API_KEY_SERVICE_TOKEN_HEADER- Header name for server-to-auth-service authenticationUNITY_MCP_API_KEY_SERVICE_TOKEN- Token value sent to the auth service for server authentication
Telemetry:
DISABLE_TELEMETRY=1- Disable anonymous telemetry (opt-out)UNITY_MCP_DISABLE_TELEMETRY=1- Same asDISABLE_TELEMETRYMCP_DISABLE_TELEMETRY=1- Same asDISABLE_TELEMETRYUNITY_MCP_TELEMETRY_ENDPOINT- Override telemetry endpoint URLUNITY_MCP_TELEMETRY_TIMEOUT- Override telemetry request timeout (seconds)
Examples
Stdio (default):
uvx --from mcpforunityserver mcp-for-unity --transport stdio
HTTP (local):
uvx --from mcpforunityserver mcp-for-unity --transport http --http-host 127.0.0.1 --http-port 8080
HTTP (remote-hosted with API key auth):
uvx --from mcpforunityserver mcp-for-unity \
--transport http \
--http-host 0.0.0.0 \
--http-port 8080 \
--http-remote-hosted \
--api-key-validation-url https://auth.example.com/api/validate-key \
--api-key-login-url https://app.example.com/api-keys
Disable telemetry:
DISABLE_TELEMETRY=1 uvx --from mcpforunityserver mcp-for-unity --transport stdio
Remote-Hosted Mode
When deploying the server as a shared remote service (e.g. for a team or Asset Store users), enable --http-remote-hosted to activate API key authentication and per-user session isolation.
Requirements:
- An external HTTP endpoint that validates API keys. The server POSTs
{"api_key": "..."}and expects{"valid": true, "user_id": "..."}or{"valid": false}in response. --api-key-validation-urlmust be provided (orUNITY_MCP_API_KEY_VALIDATION_URL). The server exits with code 1 if this is missing.
What changes in remote-hosted mode:
- All MCP tool/resource calls and Unity plugin WebSocket connections require a valid
X-API-Keyheader. - Each user only sees Unity instances that connected with their API key (session isolation).
- Auto-selection of a sole Unity instance is disabled; users must explicitly call
set_active_instance. - CLI REST routes (
/api/command,/api/instances,/api/custom-tools) are disabled. /healthand/api/auth/login-urlremain accessible without authentication.
MCP client config with API key:
{
"mcpServers": {
"UnityMCP": {
"url": "http://remote-server:8080/mcp",
"headers": {
"X-API-Key": "<your-api-key>"
}
}
}
}
For full details, see Remote Server Auth Guide and Architecture Reference.
MCP Resources
The server provides read-only MCP resources for querying Unity Editor state. Resources provide up-to-date information about your Unity project without modifying it.
Accessing Resources:
Resources are accessed by their URI (not their name). Always use ListMcpResources to get the correct URI format.
Example URIs:
mcpforunity://editor/state- Editor readiness snapshotmcpforunity://project/tags- All project tagsmcpforunity://scene/gameobject/{instance_id}- GameObject details by IDmcpforunity://prefab/{encoded_path}- Prefab info by asset path
Important: Resource names use underscores (e.g., editor_state) but URIs use slashes/hyphens (e.g., mcpforunity://editor/state). Always use the URI from ListMcpResources() when reading resources.
All resource descriptions now include their URI for easy reference. List available resources to see the complete catalog with URIs.
Example Prompts
Once connected, try these commands in your AI assistant:
- "Create a 3D player controller with WASD movement"
- "Add a rotating cube to the scene with a red material"
- "Create a simple platformer level with obstacles"
- "Generate a shader that creates a holographic effect"
- "List all GameObjects in the current scene"
Documentation
For complete documentation, troubleshooting, and advanced usage:
Requirements
- Python: 3.10 or newer
- Unity Editor: 2021.3 LTS or newer
- uv: Python package manager (Installation Guide)
License
MIT License - See LICENSE
5 maintainers
Metadata
5 maintainers
Release files for mcpforunityserver 9.6.9b20260522152000
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mcpforunityserver-9.6.9b20260522152000.tar.gz | 313.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mcpforunityserver-9.6.9b20260522152000-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 617.3 kB
Release files / mcpforunityserver-9.6.9b20260522152000.tar.gz
| Download URL | mcpforunityserver-9.6.9b20260522152000.tar.gz |
|---|---|
| Size | 313.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f3456f1b187b542d5f2f787a4a3606a9f454479bb7d0a332b04aab3f4c6daf31
|
|
BLAKE2b-256 checksum How to use checksums |
9a463aa0e41ccfa8bcd86ed8138c9032a76480a1007d5a6fd4f4774280f67c68
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 22, 2026.
Transparency logRelease files / mcpforunityserver-9.6.9b20260522152000-py3-none-any.whl
| Download URL | mcpforunityserver-9.6.9b20260522152000-py3-none-any.whl |
|---|---|
| Size | 303.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a4ec7b181a2225ccb9338e2388bc9573444d7431714eef7c04c5fc94a1752d82
|
|
BLAKE2b-256 checksum How to use checksums |
fddbd5982e014312787b4bc3b39e3886d55666586b4e00e117afcb0234315648
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 22, 2026.
Transparency log
