Reavorse MCP

🚀 Unity MCP Package

A Unity package focused on enhancing material editing capabilities, built upon the original MCP functionality. Currently, only material enhancement features are implemented, but the project is under active development and will be updated regularly. Upcoming features include lighting effects, advanced material properties, physics integration, terrain enhancement, etc. This package serves as a bridge between Unity and Large Language Models (LLMs), enabling the sending of commands and receiving of responses between Unity and MCP-compatible tools through the Model Context Protocol (MCP).

🚀 Quick Start

Unity MCP Package is a powerful tool that enhances material editing in Unity. It provides a wide range of features and capabilities to streamline your development process.

✨ Features

Overview

The Unity MCP server offers a bidirectional communication channel between Unity (via C#) and a Python server, enabling the following:

• Asset Management: Create, import, and manipulate Unity assets.
• Scene Control: Manage scenes, objects, and their properties.
• Enhanced Material Editing: Apply and modify materials with improved lighting and shader support.
• Script Integration: Create, view, and update C# scripts in Unity.
• Editing Automation: Control Unity editor functions such as undo, redo, play mode, and the build process.
• Other Unity Features: Leverage new experimental features such as advanced lighting control and post-processing effects.

This project is ideal for developers looking to enhance their Unity projects with LLMs or automate repetitive tasks.

Specific Features

• Bidirectional Communication: Efficiently send commands and receive responses between Unity and Python.
• Asset Management: Easily manage Unity assets to improve development efficiency.
• Scene Control: Fine-tune scene objects to optimize the editing process.
• Enhanced Material Editing: Achieve higher-quality material effects with improved lighting and shader support.
• Script Integration: Seamlessly integrate C# scripts to extend Unity functionality.
• Editing Automation: Automate common editing tasks to boost development efficiency.
• Other Features: Explore new possibilities with experimental features.

📦 Installation

To use the Unity MCP package, ensure you have the following installed:

• Unity 2020.3 LTS or higher (⚠️ Currently only works in URP projects)
• Python 3.12 or higher
• uv package manager

Step 1: Install Python

Download and install Python 3.12 or higher from python.org. Make sure to add Python to your system PATH during installation.

Step 2: Install uv

uv is a Python package manager that simplifies dependency management. Install it using the following commands based on your operating system:

• Mac:

brew install uv

• Windows:

powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

Then, add uv to your PATH:

set Path=%USERPROFILE%\.local\bin;%Path%

• Linux:

curl -LsSf https://astral.sh/uv/install.sh | sh

For other installation methods, refer to the uv installation guide.

Note: You cannot proceed without installing uv.

Step 3: Install the Unity Package

1. Open Unity and go to Window > Package Manager.
2. Click the + button and select Add package from Git URL.
3. Enter: https://github.com/HuangChILun/reavorse-mcp.git

After installation, the Unity MCP package will be available in your Unity project. The server will start automatically when using an MCP client such as Claude Desktop or Cursor.

🛠️ Troubleshooting

Problem 1: Unity Bridge is not running

Ensure that the Unity editor is open and the MCP server is running. If you need help, refer to the official documentation.

Problem 2: Error installing Python

Check if your operating system supports the minimum Python version requirement (3.12 or higher). If you still have issues, contact the Python community for assistance.

Problem 3: uv tool is not installed

Reinstall the uv tool following the steps above and ensure that its path is configured correctly. If the problem persists, visit the uv official website for more information.

📞 Contact

To contact the developers or get support, visit the GitHub repository or email us at contact@unitymcp.com.

🙏 Acknowledgments

We would like to thank the following individuals and projects for their contributions:

• The authors of the original MCP protocol.
• The support and feedback from the Unity community.
• All developers who have contributed to improving this project.