Unity MCP Server

@GrandMasterK414

Repository

About Unity MCP Server

Unity MCP Server for integration with Smithery.ai

Config

No standard config provided

This server doesn't expose a parseable MCP config block in its README. See the repository for install instructions.

Repository

Tools

Reads the contents of a file in the Unity project

Searches for text patterns in project files

Lists project assets of a certain type or in a folder

Gets high-level information about the Unity project

Parses a Unity scene file to extract game objects hierarchy

Parses a Unity prefab file to extract components

Finds scenes containing a specific GameObject or component

Compiles C# code to find compiler errors

Finds references to a C# class or method

Creates a new C# script file from a template

Compiles a shader and reports errors

Inspects a YAML asset file

Runs Unity's automated tests in batch mode

Experimental - runs a scene in play mode for a short duration

Overview

What is Unity MCP Server?

A Model Context Protocol (MCP) server that bridges AI assistants (e.g., Cursor AI, Claude) with Unity projects. It runs in batch mode and provides tools for reading files, parsing scenes/prefabs, analyzing C# code, running tests, and more.

How to use Unity MCP Server?

Install Node.js 16+ and Unity 2022.3 LTS+, clone the repository, run npm install && npm build, then configure config/default.json with your Unity and project paths. Start with npm start or for Smithery mode npm run smithery:start. It can also be run in a Docker container.

Key features of Unity MCP Server?

Read and search files in Unity projects
Parse Unity scenes and prefabs
Analyze C# code and detect compiler errors
Run automated tests in batch mode
Generate C# scripts from templates
Validate shaders and inspect YAML assets

Use cases of Unity MCP Server?

Debug C# compilation errors during development
Search for text patterns across project files
Extract game object hierarchy from scenes/prefabs
Run unit tests without the Unity Editor GUI
Automate script generation from templates

FAQ from Unity MCP Server

What are the system requirements?

Node.js 16+ and Unity 2022.3 LTS or newer are required.

How do I configure the Unity executable and project paths?

Edit config/default.json and set the unityPath and projectPath fields under the unity section.

How do I start the server?

Run npm start from the project directory, or npm run smithery:start for Smithery integration.

Can I run the server in Docker?

Yes, a Dockerfile is included. Build with docker build -t unity-mcp-server . and mount your project as a volume.

What tools are available?

The server provides 14 tools including open_file, search_files, parse_scene, analyze_cs_code, run_tests, generate_script, validate_shader, and more.

Frequently asked questions

What are the system requirements?

Node.js 16+ and Unity 2022.3 LTS or newer are required.

How do I configure the Unity executable and project paths?

Edit `config/default.json` and set the `unityPath` and `projectPath` fields under the `unity` section.

How do I start the server?

Run `npm start` from the project directory, or `npm run smithery:start` for Smithery integration.

Can I run the server in Docker?

Yes, a Dockerfile is included. Build with `docker build -t unity-mcp-server .` and mount your project as a volume.

What tools are available?

The server provides 14 tools including `open_file`, `search_files`, `parse_scene`, `analyze_cs_code`, `run_tests`, `generate_script`, `validate_shader`, and more.

Comments

Basic information

More Other MCP servers

Figs, Relationship Expert

Figs O'Sullivan, LMFT

Couples therapist Figs O'Sullivan (LMFT, 17 years, endorsed by Sue Johnson, creator of EFT) inside your AI. Ask relationship questions answered from his clinical writing, name the pattern in a fight, get a three-step rep