Unity-MCP copilot-instructions.md

Project Guidelines

Critical Rules

No C# Reflection for Private Access

PROHIBITED: Using System.Reflection to access private, internal, or otherwise non-public fields, properties, methods, or classes in project code. This includes Type.GetType, BindingFlags.NonPublic, GetMethod, GetField, GetProperty, and similar reflection APIs when used to bypass access modifiers.

Example of prohibited code:

// WRONG: Accessing internal Unity API via reflection
var logEntriesType = Type.GetType("UnityEditor.LogEntries, UnityEditor.CoreModule")
                  ?? Type.GetType("UnityEditorInternal.LogEntries, UnityEditor.CoreModule")
                  ?? Type.GetType("UnityEditor.LogEntries, UnityEditor")
                  ?? Type.GetType("UnityEditorInternal.LogEntries, UnityEditor");
logEntriesType?.GetMethod("Clear", BindingFlags.Static | BindingFlags.Public)
              ?.Invoke(null, null);

Note: This rule does NOT apply to ReflectorNet library usage, which is an external dependency specifically designed for reflection-based access patterns.

Code Review

Before performing any code review, you MUST read the project constitution: .specify/memory/constitution.md. All code review feedback must verify adherence to the principles defined in the constitution. Constitution principles supersede ad-hoc practices when conflicts arise.

Code Style

• C#: Use 4 spaces indentation. PascalCase for classes/methods/properties, _camelCase for private readonly fields.
  • Namespace: com.IvanMurzak.Unity.MCP.
  • Example: UnityMcpPlugin.cs.
• PowerShell: Use K&R brace style.

Architecture

• Unity-MCP-Plugin: Main Unity package.
  • Core logic: Packages/com.ivanmurzak.unity.mcp/Runtime.
  • Editor logic: Packages/com.ivanmurzak.unity.mcp/Editor.
  • Tests: Packages/com.ivanmurzak.unity.mcp/Tests.
• MCP Server: lives in the shared GameDev-MCP-Server repo (binary gamedev-mcp-server); the plugin downloads the release pinned by McpServerManager.ServerVersion.
• Installer: Installer/ wraps the package installation.
• Unity-Tests: Unity-Tests/ contains projects for different Unity versions (2022, 2023, 6000) linking locally to the Plugin.