MCP Unity

🚀 MCP Unity Project Documentation

This project provides a Unity plugin for MCP, enabling data interaction between models and optimizing editor performance through real - time communication.

🚀 Quick Start

📦 Installation

Download and Install

1. Download the MCP Unity plugin.
2. Extract the files and place them in a suitable location.

Configuration Steps

1. Open the Unity editor and go to Edit > Project Settings.
2. Select the MCP Settings tab.
3. Specify your MCP server path in Server Location.
4. Click Apply to save the settings.

✨ Features

Core Features

• Model Context Support: Enables data interaction between models.
• WebSocket Communication: Optimizes editor performance through real - time communication.

Usage Guide

1. Create a new scene or open an existing one in Unity.
2. Add the MCP component to the target object.
3. Configure the component parameters to meet project requirements.

🔧 Server Configuration

Node.js Installation

1. Visit the Node.js official website to download and install the latest LTS version.
2. Ensure the npm command is available in the terminal.

Server - side Code Compilation

# Switch to the Server directory
cd Absolute/Path/To/mcp-unity/Server

# Install dependencies
npm install

# Compile the project
npm run build

💻 Plugin Debugging

Debug Configuration

1. Enable debug mode in the Unity editor.
2. Use a browser to access localhost:8080 to view debug information.

Logging

• Console Logs: Enabled by default, output to the terminal or a specified file.
• Verbose Logs: Enable verbose logs by setting the environment variable DEBUG=*.

❓ Frequently Asked Questions

Connection Issues

1. Ensure the server is running (check the Unity console).
2. Check firewall settings to ensure the port is not blocked.
3. Verify that the port number is correct (default is 8080).

Service Startup Failure

• Check the error messages in the Unity console.
• Ensure Node.js is correctly installed and added to the path.
• Verify that all dependencies in the server directory are complete.

🛠️ Support and Feedback

If you need help or have any suggestions, please submit an issue in the GitHub repository.

Contact Information:

• LinkedIn: Miguel Tomás
• Discord: gamester7178
• Email: game.gamester@gmail.com

🤝 Contribution Guidelines

Contributions are welcome! Please submit Pull Requests or Issues following the Conventional Commits format.

📄 License

This project is licensed under the MIT License.

🙏 Acknowledgments

Thanks to the contributions of the following projects:

• Model Context Protocol
• Unity Technologies
• Node.js
• WebSocket - Sharp