Unitymcp VRC

🚀 UnityMCP Forked Project

This repository is a fork of Arodoid/UnityMCP, with extensive refactoring. It aims to support the creation of VRChat worlds using Claude/MCP/Unity, and also includes many general improvements useful for regular Unity development.

🚀 Quick Start

1. Build the MCP server in the unity-mcp-server directory:
   • Open a terminal, navigate to the directory, and run the build command.
2. Copy the UnityMCPPlugin folder to the Assets folder of your project, and find the new menu option in Unity:
   • Make sure the plugin is correctly imported and enabled in the project settings.
3. Enable developer mode on Claude Desktop and add the following MCP server settings:

   {
     "server": "http://localhost:XXXX"
   }
   

   Here, XXXX is the actual port number on which the server is running.
4. Verify the connection status, run prompts, and use the resource attachment feature:
   • Ensure that all necessary port and firewall settings are correctly configured to allow communication.

✨ Features

Command Execution

• Modified the code execution method to allow large language models (LLMs) to define using statements, classes, and functions.
  • Enables LLMs to execute more complex commands, including multiple functions.
• Since error stacks consume a large amount of context information, returning only the first line is usually sufficient.
• Added references to the following modules:
  • .Net Standard
  • System.Core, System.IO
  • TextMeshPro assemblies
  • VRChat assemblies
  • Unity Physics
  • A reference to MCPUnity itself to provide auxiliary functions for MCP commands.

Unity Editor Integration

• Added the ability to wait/retry when Unity is not connected.
• Changed getEditorState to run on demand.
• Implemented waiting for compilation to complete when getting the editor state and executing commands.
• Re-implemented GetAssets to retrieve all content located in the Assets folder.

Manual Script Testing

• Created a script testing tool for diagnosing C# commands.
• Allows manual execution of editor commands with detailed logs.

MCP Resources

• Exposes any files added to the resources/text folder as MCP resources.

Performance

• Reduced the high CPU usage of the MCP window by redrawing only when changes are detected.
• Supports commands larger than 4KB in Unity.
• Reduced excessive debug logs during the reconnection process.

Code Refactoring

• Refactored the Unity connection logic into a separate file.
• Separated the MCP server tools into a separate file and implemented a general interface to simplify the addition of new features.
• Split the editor state reporting and command execution into separate files.

VRChat-Specific Features

• Added an auxiliary script to generate UdonSharp asset files from C# files.

📄 License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International License.