# MCP Unity Editor (Game Engine) [![](https://badge.mcpx.dev?status=on 'MCP Enabled')](https://modelcontextprotocol.io/introduction) [![](https://img.shields.io/badge/Unity-000000?style=flat&logo=unity&logoColor=white 'Unity')](https://unity.com/releases/editor/archive) [![](https://img.shields.io/badge/Node.js-339933?style=flat&logo=nodedotjs&logoColor=white 'Node.js')](https://nodejs.org/en/download/) [![smithery badge](https://smithery.ai/badge/@CoderGamester/mcp-unity)](https://smithery.ai/server/@CoderGamester/mcp-unity) [![](https://img.shields.io/github/stars/CoderGamester/mcp-unity 'Stars')](https://github.com/CoderGamester/mcp-unity/stargazers) [![](https://img.shields.io/github/last-commit/CoderGamester/mcp-unity 'Last Commit')](https://github.com/CoderGamester/mcp-unity/commits/main) [![](https://img.shields.io/badge/License-MIT-red.svg 'MIT License')](https://opensource.org/licenses/MIT) | [English](README.md) | [🇨🇳简体中文](README_zh-CN.md) | [🇯🇵日本語](README-ja.md) | |----------------------|---------------------------------|----------------------| ``` ,/(/. *(/, */(((((/. *((((((*. .*((((((((((/. *((((((((((/. ./((((((((((((((/ *((((((((((((((/, ,/(((((((((((((/*. */(((((((((((((/*. ,%%#((/((((((* ,/(((((/(#&@@( ,%%##%%##((((((/*. ,/((((/(#&@@@@@@( ,%%######%%##((/(((/*. .*/(((//(%@@@@@@@@@@@( ,%%####%#(%%#%%##((/((((((((//#&@@@@@@&@@@@@@@@( ,%%####%( /#%#%%%##(//(#@@@@@@@%, #@@@@@@@( ,%%####%( *#%###%@@@@@@( #@@@@@@@( ,%%####%( #%#%@@@@, #@@@@@@@( ,%%##%%%( #%#%@@@@, #@@@@@@@( ,%%%#* #%#%@@@@, *%@@@( ., ,/##*. #%#%@@@@, ./&@#* *` ,/#%#####%%#/, #%#%@@@@, ,/&@@@@@@@@@&\. `*#########%%%%###%@@@@@@@@@@@@@@@@@@&*´ `*%%###########%@@@@@@@@@@@@@@&*´ `*%%%######%@@@@@@@@@@&*´ `*#%%##%@@@@@&*´ `*%#%@&*´ ███╗ ███╗ ██████╗██████╗ ██╗ ██╗███╗ ██╗██╗████████╗██╗ ██╗ ████╗ ████║██╔════╝██╔══██╗ ██║ ██║████╗ ██║██║╚══██╔══╝╚██╗ ██╔╝ ██╔████╔██║██║ ██████╔╝ ██║ ██║██╔██╗ ██║██║ ██║ ╚████╔╝ ██║╚██╔╝██║██║ ██╔═══╝ ██║ ██║██║╚██╗██║██║ ██║ ╚██╔╝ ██║ ╚═╝ ██║╚██████╗██║ ╚██████╔╝██║ ╚████║██║ ██║ ██║ ╚═╝ ╚═╝ ╚═════╝╚═╝ ╚═════╝ ╚═╝ ╚═══╝╚═╝ ╚═╝ ╚═╝ ``` MCP Unity is an implementation of the Model Context Protocol for Unity Editor, allowing AI assistants to interact with your Unity projects. This package provides a bridge between Unity and a Node.js server that implements the MCP protocol, enabling AI agents like Claude, Windsurf, and Cursor to execute operations within the Unity Editor. ## Features

### IDE Integration - Package Cache Access MCP Unity provides automatic integration with VSCode-like IDEs (Visual Studio Code, Cursor, Windsurf) by adding the Unity `Library/PackedCache` folder to your workspace. This feature: - Improves code intelligence for Unity packages - Enables better autocompletion and type information for Unity packages - Helps AI coding assistants understand your project's dependencies ### MCP Server Tools - `execute_menu_item`: Executes Unity menu items (functions tagged with the MenuItem attribute) > **Example prompt:** "Execute the menu item 'GameObject/Create Empty' to create a new empty GameObject" - `select_gameobject`: Selects game objects in the Unity hierarchy by path or instance ID > **Example prompt:** "Select the Main Camera object in my scene" - `update_component`: Updates component fields on a GameObject or adds it to the GameObject if it does not contain the component > **Example prompt:** "Add a Rigidbody component to the Player object and set its mass to 5" - `add_package`: Installs new packages in the Unity Package Manager > **Example prompt:** "Add the TextMeshPro package to my project" - `run_tests`: Runs tests using the Unity Test Runner > **Example prompt:** "Run all the EditMode tests in my project" - `notify_message`: Displays messages in the Unity Editor > **Example prompt:** "Send a notification to Unity that the task has been completed" - `add_asset_to_scene`: Adds an asset from the AssetDatabase to the Unity scene > **Example prompt:** "Add the Player prefab from my project to the current scene" ### MCP Server Resources - `unity://menu-items`: Retrieves a list of all available menu items in the Unity Editor to facilitate `execute_menu_item` tool > **Example prompt:** "Show me all available menu items related to GameObject creation" - `unity://hierarchy`: Retrieves a list of all game objects in the Unity hierarchy > **Example prompt:** "Show me the current scene hierarchy structure" - `unity://gameobject/{id}`: Retrieves detailed information about a specific GameObject by instance ID or object path in the scene hierarchy, including all GameObject components with it's serialized properties and fields > **Example prompt:** "Get me detailed information about the Player GameObject" - `unity://logs`: Retrieves a list of all logs from the Unity console > **Example prompt:** "Show me the recent error messages from the Unity console" - `unity://packages`: Retrieves information about installed and available packages from the Unity Package Manager > **Example prompt:** "List all the packages currently installed in my Unity project" - `unity://assets`: Retrieves information about assets in the Unity Asset Database > **Example prompt:** "Find all texture assets in my project" - `unity://tests/{testMode}`: Retrieves information about tests in the Unity Test Runner > **Example prompt:** "List all available tests in my Unity project" ## Requirements - Unity 2022.3 or later - to [install the server](#install-server) - Node.js 18 or later - to [start the server](#start-server) - npm 9 or later - to [debug the server](#debug-server) ## Installation Installing this MCP Unity Server is a multi-step process: ### Step 1: Install Unity MCP Server package via Unity Package Manager 1. Open the Unity Package Manager (Window > Package Manager) 2. Click the "+" button in the top-left corner 3. Select "Add package from git URL..." 4. Enter: `https://github.com/CoderGamester/mcp-unity.git` 5. Click "Add" ![package manager](https://github.com/user-attachments/assets/a72bfca4-ae52-48e7-a876-e99c701b0497) ### Step 2: Install Node.js > To run MCP Unity server, you'll need to have Node.js 18 or later installed on your computer:

Windows

1. Visit the [Node.js download page](https://nodejs.org/en/download/) 2. Download the Windows Installer (.msi) for the LTS version (recommended) 3. Run the installer and follow the installation wizard 4. Verify the installation by opening PowerShell and running: ```bash node --version ```

macOS

1. Visit the [Node.js download page](https://nodejs.org/en/download/) 2. Download the macOS Installer (.pkg) for the LTS version (recommended) 3. Run the installer and follow the installation wizard 4. Alternatively, if you have Homebrew installed, you can run: ```bash brew install node@18 ``` 5. Verify the installation by opening Terminal and running: ```bash node --version ```

### Step 3: Configure AI LLM Client

Option 1: Configure using Unity Editor

1. Open the Unity Editor 2. Navigate to Tools > MCP Unity > Server Window 3. Click on the "Configure" button for your AI LLM client as shown in the image below ![image](https://github.com/user-attachments/assets/8d286e83-da60-40fa-bd6c-5de9a77c1820) 4. Confirm the configuration installation with the given popup ![image](https://github.com/user-attachments/assets/b1f05d33-3694-4256-a57b-8556005021ba)

Option 2: Configure Manually

Open the MCP configuration file of your AI client (e.g. claude_desktop_config.json in Claude Desktop) and copy the following text: > Replace `ABSOLUTE/PATH/TO` with the absolute path to your MCP Unity installation or just copy the text from the Unity Editor MCP Server window (Tools > MCP Unity > Server Window). ```json { "mcpServers": { "mcp-unity": { "command": "node", "args": [ "ABSOLUTE/PATH/TO/mcp-unity/Server/build/index.js" ] } } } ```

## Start Unity Editor MCP Server 1. Open the Unity Editor 2. Navigate to Tools > MCP Unity > Server Window 3. Click "Start Server" to start the WebSocket server 4. Open Claude Desktop or your AI Coding IDE (e.g. Cursor IDE, Windsurf IDE, etc.) and start executing Unity tools ![connect](https://github.com/user-attachments/assets/2e266a8b-8ba3-4902-b585-b220b11ab9a2) > When the AI client connects to the WebSocket server, it will automatically show in the green box in the window ## Optional: Set WebSocket Port By default, the WebSocket server runs on port 8090. You can change this port in two ways:

Option 1: Using the Unity Editor

1. Open the Unity Editor 2. Navigate to Tools > MCP Unity > Server Window 3. Change the "WebSocket Port" value to your desired port number 4. Unity will setup the system environment variable UNITY_PORT to the new port number 5. Restart the Node.js server 6. Click again on "Start Server" to reconnect the Unity Editor web socket to the Node.js MCP Server

Option 2: Using the terminal

1. Set the UNITY_PORT environment variable in the terminal - Powershell ```powershell $env:UNITY_PORT = "8090" ``` - Command Prompt/Terminal ```cmd set UNITY_PORT=8090 ``` 2. Restart the Node.js server 3. Click again on "Start Server" to reconnect the Unity Editor web socket to the Node.js MCP Server

## Debugging the Server

Building the Node.js Server

The MCP Unity server is built using Node.js . It requires to compile the TypeScript code to JavaScript in the `build` directory. To build the server, open a terminal and: 1. Navigate to the Server directory: ```bash cd ABSOLUTE/PATH/TO/mcp-unity/Server ``` 2. Install dependencies: ```bash npm install ``` 3. Build the server: ```bash npm run build ``` 4. Run the server: ```bash node build/index.js ```

Debugging with MCP Inspector

Debug the server with [@modelcontextprotocol/inspector](https://github.com/modelcontextprotocol/inspector): - Powershell ```powershell npx @modelcontextprotocol/inspector node Server/build/index.js ``` - Command Prompt/Terminal ```cmd npx @modelcontextprotocol/inspector node Server/build/index.js ``` Don't forget to shutdown the server with `Ctrl + C` before closing the terminal or debugging it with the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).

Enable Console Logs

1. Enable logging on your terminal or into a log.txt file: - Powershell ```powershell $env:LOGGING = "true" $env:LOGGING_FILE = "true" ``` - Command Prompt/Terminal ```cmd set LOGGING=true set LOGGING_FILE=true ```

## Troubleshooting

Connection Issues

- Ensure the WebSocket server is running (check the Server Window in Unity) - Check if there are any firewall restrictions blocking the connection - Make sure the port number is correct (default is 8080) - Change the port number in the Unity Editor MCP Server window. (Tools > MCP Unity > Server Window)

Server Not Starting

- Check the Unity Console for error messages - Ensure Node.js is properly installed and accessible in your PATH - Verify that all dependencies are installed in the Server directory

Menu Items Not Executing

- Ensure the menu item path is correct (case-sensitive) - Check if the menu item requires confirmation - Verify that the menu item is available in the current context

## Support & Feedback If you have any questions or need support, please open an [issue](https://github.com/CoderGamester/mcp-unity/issues) on this repository. Alternative you can reach out on: - Linkedin: [![](https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white 'LinkedIn')](https://www.linkedin.com/in/miguel-tomas/) - Discord: gamester7178 - Email: game.gamester@gmail.com ## Contributing Contributions are welcome! Please feel free to submit a Pull Request or open an Issue with your request. **Commit your changes** following the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. ## License This project is under [MIT License](License.md) ## Acknowledgements - [Model Context Protocol](https://modelcontextprotocol.io) - [Unity Technologies](https://unity.com) - [Node.js](https://nodejs.org) - [WebSocket-Sharp](https://github.com/sta/websocket-sharp)