Skip to main content

Python MCP server for Unity Editor — enables AI assistants to control Unity via the Model Context Protocol

Project description

unity-mcp-server

Python MCP server for Unity MCP — enables AI assistants (Claude, Cursor, VS Code Copilot, Windsurf) to control the Unity Editor via the Model Context Protocol.

Quick Start

1. Install the Unity package

In Unity: Window > Package Manager > + > Add package from git URL:

https://github.com/mzbswh/unity-mcp.git?path=unity-mcp

2. Configure your MCP client

Add to your MCP client config (e.g. .cursor/mcp.json, .vscode/mcp.json):

{
  "mcpServers": {
    "unity": {
      "command": "uvx",
      "args": ["unity-mcp-server"]
    }
  }
}

Or use Window > Unity MCP > Clients tab in Unity for one-click configuration.

3. Verify

Ask your AI assistant: "List all GameObjects in my Unity scene"

Streamable HTTP Mode

By default the server runs in stdio mode (MCP client launches it automatically). To run as a standalone HTTP server:

UNITY_MCP_TRANSPORT=streamable-http uvx unity-mcp-server

Then configure your MCP client with http://127.0.0.1:8080/mcp.

Environment Variables

Variable Default Description
UNITY_MCP_HOST 127.0.0.1 Unity Editor host address
UNITY_MCP_PORT 51279 Unity Editor TCP port
UNITY_MCP_TIMEOUT 60 Request timeout (seconds)
UNITY_MCP_TRANSPORT stdio Transport mode: stdio or streamable-http
UNITY_MCP_HTTP_PORT 8080 HTTP port (only for streamable-http mode)

Docker

cd unity-server

# stdio mode (default)
docker compose up -d

# Streamable HTTP mode
UNITY_MCP_TRANSPORT=streamable-http docker compose up -d

Extra Tools

In addition to all Unity Editor tools (60+), this server provides:

  • analyze_script — C# script static analysis
  • validate_assets — Asset naming and directory validation

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unity_mcp_server-1.0.2.tar.gz (10.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

unity_mcp_server-1.0.2-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file unity_mcp_server-1.0.2.tar.gz.

File metadata

  • Download URL: unity_mcp_server-1.0.2.tar.gz
  • Upload date:
  • Size: 10.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for unity_mcp_server-1.0.2.tar.gz
Algorithm Hash digest
SHA256 f9a61ee18afc33f6eb3faa9a4a8b52d24328a416d254aaa25f2f319261627ca8
MD5 27c310ff02b1496834ce10aafffcadec
BLAKE2b-256 ff9f19de84c48a2b4f4f57ec7c1c345f40ff4d1bc42f8e26f4fd586d6fe64b30

See more details on using hashes here.

File details

Details for the file unity_mcp_server-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for unity_mcp_server-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 444265002575b0fe0a940795646bc5f6c76fc0597fcf3c16274050e06a12d721
MD5 51f255c8ac7730f9d586d660bb529bcc
BLAKE2b-256 f1f5d512be7b7679591528bcd2f422d8768f9bc4c62e6a6b1af6cce8277ef4e6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page