Feature: 🔍 Enhanced Component Data Reading via Serialization

[dsarno]

This PR enhances the ManageGameObject tool to supercharge its ability to read component data accurately and comprehensively! 🚀 Basically, it can read serialized data from a bunch of different kinds of standard and custom components, and can be extended to work with even more components.

Summary:

• 🔬 Enhanced Component Reading: The new serializer now uses our custom JsonConverter implementations (Vector3Converter, ColorConverter, UnityEngineObjectConverter, etc.). This means the get_components action can reliably pull detailed info for all sorts of component data types.
• 🧹 Tidy up ManageGameObject: Extracted GameObject and Component serialization logic from the large ManageGameObject.cs into a new, dedicated GameObjectSerializer helper class (UnityMcpBridge.Editor.Helpers.GameObjectSerializer).

Enhanced Capabilities (get_components action):

The get_components action now reliably retrieves detailed information for components attached to GameObjects, including:

• Public properties and fields ✅
• Non-public fields marked with [SerializeField] (using includeNonPublicSerialized: true) 👀
• Common Unity types (Vector2/3/4, Quaternion, Color, Rect, Bounds) 🎨
• Enum values 🏷️
• Lists of supported types 📚
• Nested custom classes/structs 🪆🪆🪆
• References to other Unity Objects (GameObjects, Components, Materials, Textures, etc.), resolved by direct reference, asset path, or find instructions 🔗

Examples:

1. Get all component data for 'MCP_TestData':

   • Request:

     {
       "tool_name": "mcp_UnityMCP_manage_gameobject",
       "arguments": {
         "action": "get_components",
         "target": "MCP_TestData"
       }
     }

   • Example Response Snippet (McpTestComponent):

     {
       "typeName": "McpTestComponent",
       "instanceID": 124350, // Instance ID will vary
       "properties": {
         "publicInt": 10,
         "publicFloat": 3.14,
         "publicString": "Hello MCP",
         "publicVector3": {"x": 1.0, "y": 2.0, "z": 3.0},
         "publicColor": {"r": 1.0, "g": 0.0, "b": 0.0, "a": 1.0},
         "publicGameObjectRef": {"name": "DoorwayZone", "instanceID": 124510}, // Instance ID will vary
         "publicMaterialRef": "Assets/Art/Materials/Bun_Tan.mat",
         "publicVectorList": [{"x": 1.0, "y": 1.0, "z": 1.0}, {"x": 0.0, "y": 0.0, "z": 0.0}],
         "nestedData": {"IsEnabled": true, "MoreData": {"Name": "Nested", "Value": 456}, "IntList": [7, 8, 9]}
         // ... other properties ...
       }
     }

2. Inspect a UI element ('InventoryPanel'):

   • Request:

     {
       "tool_name": "mcp_UnityMCP_manage_gameobject",
       "arguments": {
         "action": "get_components",
         "target": "InventoryPanel",
         "search_method": "by_name"
       }
     }

   • Example Response Snippet (Image Component):

     {
       "typeName": "UnityEngine.UI.Image",
       "instanceID": -137898, // Instance ID will vary
       "properties": {
         "sprite": {"name": "UI_Square_Frame01", "instanceID": 124818}, // Instance ID will vary
         "color": {"r": 0.19, "g": 0.19, "b": 0.19, "a": 1.0},
         "material": "Assets/Settings/URP/Resources/Materials/UI_Default.mat",
         "raycastTarget": true,
         "type": 1, // Sliced
         "pixelsPerUnitMultiplier": 1.0
         // ... other properties ...
       }
     }

Future Considerations:

• 🌱 The GameObjectSerializer and the UnityMcpBridge.Runtime.Serialization converters provide a solid foundation. We can easily add support for more complex or custom data types in the future by creating new JsonConverter implementations, making this tool even more powerful! 💪

(Note: This PR also implicitly includes commits that added missing essential package files (.asmdef, .meta, runtime scripts) to the repository, which were necessary to resolve compilation errors when loading the package remotely via Git.)

Summary by CodeRabbit

• New Features

  • Introduced robust serialization for Unity objects, enabling detailed data capture and smoother multi-channel responses.
  • Added enhanced JSON converters for Unity-specific types, ensuring accurate data exchange.
  • Expanded game object management functionality with an option to include additional serialized details.

• Enhancements

  • Improved error feedback during command processing for clearer user responses.

[dsarno]

You can see the full CodeRabbit of this PR on my fork: dsarno#2

[dsarno]

One of my Cursor cleanups deleted a bunch of @justinpbarnett 's comments in ManageGameObject.cs. I tried to restore them from a diff but there were too many and it didn't really work. We could either ask for AI help to regenerate inline comments, or I can try to rebuild the whole file based on your commented version (actually already did try that, and it wasn't that easy). Let me know what you think and thanks!

[dsarno]

@justinpbarnett Think you'll have a few minutes to try it? Spent a solid couple days putting it together.

[Copilot]

Pull Request Overview

This PR enriches the ManageGameObject workflow by introducing robust serialization of component data (including non-public [SerializeField] fields) and by extracting serialization logic into a dedicated helper.

• Added an includeNonPublicSerialized parameter to the Python tool for controlling private field serialization.
• Introduced new JsonConverter implementations for Unity types (Vector, Color, Bounds, etc.).
• Refactored the C# ManageGameObject editor script to delegate serialization to the new GameObjectSerializer helper.
• Created GameObjectSerializer in UnityMcpBridge.Editor.Helpers to centralize and cache reflection-based serialization.

Reviewed Changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated 2 comments.

File	Description
UnityMcpServer/src/tools/manage_gameobject.py	Added includeNonPublicSerialized argument and updated docs.
UnityMcpBridge/Runtime/Serialization/UnityTypeConverters.cs	Added converters for Vector2/3/4, Color, Rect, Bounds, Object.
UnityMcpBridge/Editor/Tools/ManageGameObject.cs	Refactored to pass flag and use GameObjectSerializer.
UnityMcpBridge/Editor/Helpers/GameObjectSerializer.cs	New helper class encapsulating gameobject/component serialization.

Comments suppressed due to low confidence (6)

UnityMcpServer/src/tools/manage_gameobject.py:38

• [nitpick] Parameter name includeNonPublicSerialized uses CamelCase and does not follow PEP8 snake_case conventions; consider renaming to include_non_public_serialized for consistency.

        includeNonPublicSerialized: bool = None, # Controls serialization of private [SerializeField] fields

UnityMcpBridge/Editor/Helpers/GameObjectSerializer.cs:124

• [nitpick] Numerous commented-out debug logs remain in GameObjectSerializer; consider removing or gating them behind a debug flag to improve readability.

            // --- Add Early Logging --- 

UnityMcpServer/src/tools/manage_gameobject.py:65

• [nitpick] Docstring formatting for the 'get_components' section has inconsistent indentation and list alignment; consider normalizing indentation for better readability.

            Action-specific details:

UnityMcpBridge/Editor/Helpers/GameObjectSerializer.cs:1

• [nitpick] GameObjectSerializer is very large and handles many responsibilities; consider splitting it into smaller focused classes or regions (e.g., converters, caching, reflection) to improve maintainability.

using System;

UnityMcpBridge/Editor/Tools/ManageGameObject.cs:5

• [nitpick] This using directive may no longer be needed after refactoring; consider removing unused imports to reduce clutter.

using Newtonsoft.Json; // Added for JsonSerializationException

UnityMcpBridge/Editor/Tools/ManageGameObject.cs:13

• [nitpick] Import of UnityMcpBridge.Runtime.Serialization may be unused in this file; verify and remove if unnecessary.

using UnityMcpBridge.Runtime.Serialization; // <<< Keep for Converters access? Might not be needed here directly

[Scriptwonder]

Hi, looks good to me at this point. I will first merge it and run it myself (some deprecations at this point). Let me know what you are cooking next!