Provides structured access to Unity projects, allowing agents to query project metadata, retrieve build settings and scene lists, and read project-specific documentation without requiring the Unity Editor.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Unity MCP ServerShow me the Unity version and the scenes in the build order."
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Unity MCP Server
A lightweight Model Context Protocol (MCP) server that gives AI assistants structured access to your Unity projects. Query project metadata, build settings, and agent documentation from any MCP-capable client—without running the Unity Editor.
Overview
Unity MCP Server runs as a separate process and reads your Unity project from disk. Point it at any project root via UNITY_PROJECT_PATH; one installation can serve multiple projects by changing the environment variable in your client config.
Key points:
Editor-free — Uses only the project filesystem. No Unity process or Editor dependency.
Single binary — One Node.js server for all your Unity projects.
MCP-native — Built on the official MCP SDK; works with Cursor, Claude Desktop, Windsurf, and other MCP clients.
Features
Tool | Description |
| Returns project root path, Unity version, and build scene count. |
| Returns scenes in |
| Returns contents of |
Prerequisites
Node.js 18 or later
UNITY_PROJECT_PATH — Absolute path to your Unity project root (set in your MCP client configuration)
Installation
The server is invoked via stdio. Your MCP client starts it; you do not run it manually in production.
Configuration
Cursor
Add the following to your MCP settings (project or user):
Replace:
/absolute/path/to/unity-mcp-server/dist/index.jswith the path to this repository’s built entry point./absolute/path/to/YourUnityProjectwith the absolute path to your Unity project root.
Other MCP clients
Use the same pattern: run node with dist/index.js as the argument and set UNITY_PROJECT_PATH in the environment. Refer to your client’s documentation for where to configure MCP servers.
Development
Production:
node dist/index.js(afternpm run build)Development:
npm run devornpx tsx src/index.ts
Security and public use
This repository contains only generic tooling: no game code, assets, API keys, or secrets. The Unity project path is provided at runtime by your MCP client and is not stored in this repo. Safe to use in public or private contexts. The project is maintained anonymously; no author attribution is required.
Further reading
See PURPOSE.md for the rationale behind this server and when it is useful for your workflow.