Unity

Certified

UnityMCP is a Unity editor plugin that implements the Model Context Protocol (MCP), providing seamless integration between Unity and AI assistants, including real - time state monitoring, remote command execution, and log functions.

Developer tools Games and gamification #Unity Plugin #AI Integration #Remote Control #Real - Time Monitoring Local .C#

rating : 5 points

downloads : 25.8K

update time : 2025-04-28

Open Site

What is the Model Context Protocol (MCP) Server?

The MCP server is a server - side component built on TypeScript. It communicates with the Unity editor through the WebSocket protocol, supporting real - time monitoring of the editor state, remote code execution, and comprehensive log management.

How to use the MCP server?

You can start the MCP server and connect it to a Unity project in just a few steps. First, install the server and run it. Then, load the plugin in the Unity editor and set up the connection.

Applicable scenarios

The MCP server is well - suited for teams that need to automate the development process, improve collaboration efficiency, and enhance AI - assisted design capabilities.

Main Features

Get Editor State

Get the current state of the Unity editor in real - time, including active game objects, selection state, play mode, etc.

Execute Editor Command

Allow direct execution of C# code in the Unity editor, accessing the UnityEngine and UnityEditor APIs.

Get Logs

Collect and filter logs in the Unity editor, supporting filtering by type, content, and time.

Advantages

Support real - time two - way communication to improve collaboration efficiency.

Powerful error handling mechanism to ensure stable operation.

Flexible log management function for easy debugging and optimization.

Strong cross - platform compatibility, suitable for multiple operating systems.

Limitations

Requires a certain network environment to support WebSocket.

Initial configuration may be difficult for beginners.

Some advanced features may depend on specific versions of the Unity editor.

How to Use

Install the MCP Server

Clone the project code and install the dependencies.

Start the Server

Run the built script to start listening for requests.

Configure the Unity Plugin

Import the UnityMCP plugin into the project and open the Debug window.

Usage Examples

Example 1: Centralize the Selected Object

Reset the position of the selected game object to the origin.

Example 2: Switch Play Mode

Control Unity to enter or exit play mode via script.

Frequently Asked Questions

How to solve the connection failure problem?

Can I customize the log filtering conditions?

Does it support multiple clients connecting simultaneously?

Related Resources

Official Documentation

Detailed introduction to the MCP protocol and its applications.

GitHub Repository

View the source code and contribution guidelines.

Video Tutorial

Quick start guide.

🚀 UnityMCP

UnityMCP is a powerful Unity editor plugin that implements the Model Context Protocol (MCP), enabling seamless integration between Unity and AI assistants. It offers real-time editor status monitoring, remote command execution, and comprehensive logging capabilities.

🚀 Quick Start

UnityMCP is a potent Unity editor plugin implementing the Model Context Protocol (MCP), facilitating seamless integration between Unity and AI assistants. It provides real - time editor status monitoring, remote command execution, and comprehensive logging features.

✨ Features

Core Functionality: Enables bidirectional real - time communication via WebSocket, supporting message transmission in JSON format.
Use Cases: Ideal for scenarios requiring real - time interaction, such as game development, real - time collaboration tools, or other applications that need dynamic data exchange.
Target Users: Developers, designers, and researchers.

📦 Installation

1. Install via Smithery

# Example code: Install via Smithery

2. Manual Installation

Plugin Installation:
- Place the UnityMCP folder into your Unity project.
- Import this folder in Unity to complete the plugin installation.
Server Configuration:
- Ensure Node.js and npm are installed.
- Run the following command in the project directory:
```
npm install
```

💻 Usage Examples

Start the Server

node server.js

Connect the Plugin

Open the Unity editor.
Add the MCPManager.cs script to the Assets/Editor folder.
Attach the script to an empty object.
Configure the WebSocket server address (default is ws://localhost:8080).

📚 Documentation

Compile and Build

npm run build

Monitor Code Changes

npm run watch

Debug Communication

npm run inspector

🔧 Technical Details

Communication Protocol

Transmission Method: Real - time bidirectional communication based on WebSocket.
Port Number: Default port is 8080.
Message Format: All communications use JSON format.

Security Mechanisms

Command Timeout Protection: Prevents the execution of commands with long - term non - responses.
Error Handling: Comprehensive handling of connection exceptions, command failures, compilation errors, and runtime exceptions.
Log Management: Provides reliable logging and buffering functions.
Status Monitoring: Tracks connection status in real - time to ensure system stability.

Error Handling

The system provides a comprehensive handling mechanism for the following situations:

Connection interruption
Command execution failure
Compilation errors
Runtime exceptions
Timeout issues

🤝 Contributing

Code Repository: Visit the GitHub repository.
Contribution Method:
- Fork the repository to your account.
- Create a feature branch (e.g., feature/amazing - feature).
- Commit your changes and add commit descriptions.
- Push to the remote repository.
- Submit a Pull Request.

📄 License

This project is licensed under the [Creative Commons Attribution - NonCommercial 4.0 International (CC BY - NC 4.0)](https://creativecommons.org/licenses/by - nc/4.0/) license.