Unity MCP

🚀 Unity MCP Plugin Update Log

This update log details the new features, known issues, download links, usage instructions, custom tool development guide, and contribution guidelines for the Unity MCP plugin.

✨ Features

• Updated the communication protocol between the MCP server and the client.
• Added support for custom tools.
• Provided more detailed error messages and debugging information.
• Optimized performance, especially when dealing with large-scale scenarios.

🐞 Known Issues

1. Limited Custom Tool Support: Due to some unresolved issues in the csharp-sdk, full support for custom tool development is currently unavailable. Please follow these two issues:

   • GitHub Discussion
   • GitHub Issue

2. Multithreading Limitations: Some tools may need to run outside the main thread, but the plugin currently forces the use of the main thread by default to ensure compatibility with the Unity API.

📥 Download Links

• GitHub Repository
• Releases Page

🚀 Quick Start

Project Path Requirement

• Ensure that the path of your Unity project does not contain spaces. For example:

  C:/MyProjects/Project
  

  Instead of:

  C:/My Projects/Project
  

Access the Plugin

• After opening your Unity project, go to the menu Window -> AI Connector (Unity-MCP).

  

Install the MCP Client

• It is recommended to use Cursor.
• Alternatively, you can use Claude.

Log in to Your Account

• Log in to your account in the MCP client.

Configure the Plugin

• Click Configure to configure the plugin.

  

Restart the MCP Client

• Restart the MCP client.

Check the Connection Status

• Ensure that the AI Connector status is "Connected" or "Connecting...".

Test the Plugin

• Test the plugin features in your MCP client, such as:
  • Analyze the scene using the default tools.
  • Verify the invocation of custom tools.

💻 Usage Examples

Create a Tool Class

1. Create a new class that inherits from MCP_Tool.
2. Add the [McpTool] attribute to the class and specify the tool name and description.

[McpTool("CustomTool", "This is a custom tool")]
public class CustomTool : MCP_Tool
{
    // Tool logic implementation
}

Define Methods

1. Mark executable commands with the [McpCommand] attribute.
2. Add parameter descriptions to the methods, for example:

[McpCommand("ProcessScene", "Process the current scene")]
public void ProcessScene([McpParam("filePath", "Input file path")] string filePath)
{
    // Processing logic
}

Add Parameter Descriptions

• Use the [McpParam] attribute to add description information to parameters, for example:

  [McpParam("radius", "Processing radius")]
  float radius = 1.0f;
  

🤝 Contribution Guidelines

1. Fork the Unity-MCP Repository.
2. Before submitting a Pull Request, ensure that your code passes all test cases.
3. Report issues or propose improvement suggestions in the Issues section.