Unity MCP

🚀 Unity MCP Documentation

Unity MCP (Multipurpose Controller Plugin) is a versatile plugin designed to enhance the functionality of the Unity Editor. By integrating this plugin, users can directly utilize Unity tools within the MCP client, thereby boosting development efficiency.

🚀 Quick Start

✨ Features

• Enhance the functionality of the Unity Editor.
• Enable users to use Unity tools directly in the MCP client.
• Improve development efficiency.

📦 Installation

Clone the Repository

Run the following command in the terminal to clone the repository:

git clone https://github.com/justinpbarnett/unity-mcp.git

Install Dependencies

Navigate to the project directory and install Python dependencies:

pip install -r requirements.txt

💻 Usage Examples

Basic Usage

1. Open the Unity Editor and load the relevant project.
2. Launch the MCP client (e.g., Claude, Cursor).
3. Enter commands in the MCP to invoke plugin functions.

Example

Enter the following command:

unity-mcp create-player-controller

This will create a basic player controller script.

📚 Documentation

Contribution Guidelines

1. Fork the main repository.
2. Create a new branch (e.g., feature/new-feature or bugfix/fix-issue).
3. Commit your changes and push them to the remote repository.
4. Submit a Pull Request to merge into the main branch.

Troubleshooting

Unity Editor Cannot Connect

• Ensure that the Unity Editor is running.
• Check the status of the MCP window (Window > Unity MCP).
• Restart the Unity Editor.

MCP Client Cannot Connect

• Verify that the server path is correct (e.g., /path/to/unity-mcp/server.py).
• Use the following command to verify the Python environment:

python --version

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact Information

• GitHub
• Twitter

Thank you for your support!