.agent/skills/gameobject-find/SKILL.md
Finds specific GameObject by provided information in opened Prefab or in a Scene. First it looks for the opened Prefab, if any Prefab is opened it looks only there ignoring a scene. If no opened Prefab it looks into current active scene. Returns GameObject information and its children. Also, it returns Components preview just for the target GameObject.
npx skillsauth add hth-hiro/Unity-Study gameobject-findInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
unity-mcp-cli run-tool gameobject-find --input '{
"gameObjectRef": "string_value",
"includeData": false,
"includeComponents": false,
"includeBounds": false,
"includeHierarchy": false,
"hierarchyDepth": 0
}'
For complex input (multi-line strings, code), save the JSON to a file and use:
unity-mcp-cli run-tool gameobject-find --input-file args.jsonOr pipe via stdin (recommended):
unity-mcp-cli run-tool gameobject-find --input-file - <<'EOF' {"param": "value"} EOF
If unity-mcp-cli is not found, either install it globally (npm install -g unity-mcp-cli) or use npx unity-mcp-cli instead.
Read the /unity-initial-setup skill for detailed installation instructions.
| Name | Type | Required | Description |
|------|------|----------|-------------|
| gameObjectRef | any | Yes | Find GameObject in opened Prefab or in the active Scene. |
| includeData | boolean | No | Include editable GameObject data (tag, layer, etc). |
| includeComponents | boolean | No | Include attached components references. |
| includeBounds | boolean | No | Include 3D bounds of the GameObject. |
| includeHierarchy | boolean | No | Include hierarchy metadata. |
| hierarchyDepth | integer | No | Determines the depth of the hierarchy to include. 0 - means only the target GameObject. 1 - means to include one layer below. |
{
"type": "object",
"properties": {
"gameObjectRef": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Runtime.Data.GameObjectRef"
},
"includeData": {
"type": "boolean"
},
"includeComponents": {
"type": "boolean"
},
"includeBounds": {
"type": "boolean"
},
"includeHierarchy": {
"type": "boolean"
},
"hierarchyDepth": {
"type": "integer"
}
},
"$defs": {
"System.Type": {
"type": "string"
},
"com.IvanMurzak.Unity.MCP.Runtime.Data.GameObjectRef": {
"type": "object",
"properties": {
"instanceID": {
"type": "integer",
"description": "instanceID of the UnityEngine.Object. If it is '0' and 'path', 'name', 'assetPath' and 'assetGuid' is not provided, empty or null, then it will be used as 'null'. Priority: 1 (Recommended)"
},
"path": {
"type": "string",
"description": "Path of a GameObject in the hierarchy Sample 'character/hand/finger/particle'. Priority: 2."
},
"name": {
"type": "string",
"description": "Name of a GameObject in hierarchy. Priority: 3."
},
"assetType": {
"$ref": "#/$defs/System.Type",
"description": "Type of the asset."
},
"assetPath": {
"type": "string",
"description": "Path to the asset within the project. Starts with 'Assets/'"
},
"assetGuid": {
"type": "string",
"description": "Unique identifier for the asset."
}
},
"required": [
"instanceID"
],
"description": "Find GameObject in opened Prefab or in the active Scene."
}
},
"required": [
"gameObjectRef"
]
}
{
"type": "object",
"properties": {
"result": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Runtime.Data.GameObjectData"
}
},
"$defs": {
"com.IvanMurzak.Unity.MCP.Runtime.Data.GameObjectRef": {
"type": "object",
"properties": {
"instanceID": {
"type": "integer",
"description": "instanceID of the UnityEngine.Object. If it is '0' and 'path', 'name', 'assetPath' and 'assetGuid' is not provided, empty or null, then it will be used as 'null'. Priority: 1 (Recommended)"
},
"path": {
"type": "string",
"description": "Path of a GameObject in the hierarchy Sample 'character/hand/finger/particle'. Priority: 2."
},
"name": {
"type": "string",
"description": "Name of a GameObject in hierarchy. Priority: 3."
},
"assetType": {
"$ref": "#/$defs/System.Type",
"description": "Type of the asset."
},
"assetPath": {
"type": "string",
"description": "Path to the asset within the project. Starts with 'Assets/'"
},
"assetGuid": {
"type": "string",
"description": "Unique identifier for the asset."
}
},
"required": [
"instanceID"
],
"description": "Find GameObject in opened Prefab or in the active Scene."
},
"System.Type": {
"type": "string"
},
"com.IvanMurzak.ReflectorNet.Model.SerializedMember": {
"type": "object",
"properties": {
"typeName": {
"type": "string",
"description": "Full type name. Eg: 'System.String', 'System.Int32', 'UnityEngine.Vector3', etc."
},
"name": {
"type": "string",
"description": "Object name."
},
"value": {
"description": "Value of the object, serialized as a non stringified JSON element. Can be null if the value is not set. Can be default value if the value is an empty object or array json."
},
"fields": {
"type": "array",
"items": {
"$ref": "#/$defs/com.IvanMurzak.ReflectorNet.Model.SerializedMember",
"description": "Nested field value."
},
"description": "Fields of the object, serialized as a list of 'SerializedMember'."
},
"props": {
"type": "array",
"items": {
"$ref": "#/$defs/com.IvanMurzak.ReflectorNet.Model.SerializedMember",
"description": "Nested property value."
},
"description": "Properties of the object, serialized as a list of 'SerializedMember'."
}
},
"required": [
"typeName"
],
"additionalProperties": false
},
"com.IvanMurzak.ReflectorNet.Model.SerializedMemberList": {
"type": "array",
"items": {
"$ref": "#/$defs/com.IvanMurzak.ReflectorNet.Model.SerializedMember"
}
},
"UnityEngine.Bounds": {
"type": "object",
"properties": {
"center": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
]
},
"size": {
"type": "object",
"properties": {
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"z": {
"type": "number"
}
},
"required": [
"x",
"y",
"z"
]
}
},
"required": [
"center",
"size"
],
"additionalProperties": false
},
"com.IvanMurzak.Unity.MCP.Runtime.Data.GameObjectMetadata": {
"type": "object",
"properties": {
"instanceID": {
"type": "integer"
},
"path": {
"type": "string"
},
"name": {
"type": "string"
},
"sceneName": {
"type": "string"
},
"tag": {
"type": "string"
},
"activeSelf": {
"type": "boolean"
},
"activeInHierarchy": {
"type": "boolean"
},
"children": {
"$ref": "#/$defs/System.Collections.Generic.List<com.IvanMurzak.Unity.MCP.Runtime.Data.GameObjectMetadata>"
}
},
"required": [
"instanceID",
"activeSelf",
"activeInHierarchy"
]
},
"System.Collections.Generic.List<com.IvanMurzak.Unity.MCP.Runtime.Data.GameObjectMetadata>": {
"type": "array",
"items": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Runtime.Data.GameObjectMetadata"
}
},
"com.IvanMurzak.Unity.MCP.Runtime.Data.ComponentDataShallow[]": {
"type": "array",
"items": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Runtime.Data.ComponentDataShallow"
}
},
"com.IvanMurzak.Unity.MCP.Runtime.Data.ComponentDataShallow": {
"type": "object",
"properties": {
"instanceID": {
"type": "integer"
},
"typeName": {
"type": "string"
},
"isEnabled": {
"type": "string",
"enum": [
"False",
"True",
"NA"
]
}
},
"required": [
"instanceID",
"isEnabled"
]
},
"com.IvanMurzak.Unity.MCP.Runtime.Data.GameObjectData": {
"type": "object",
"properties": {
"Reference": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Runtime.Data.GameObjectRef",
"description": "Find GameObject in opened Prefab or in the active Scene."
},
"Data": {
"$ref": "#/$defs/com.IvanMurzak.ReflectorNet.Model.SerializedMember",
"description": "GameObject editable data (tag, layer, etc)."
},
"Bounds": {
"$ref": "#/$defs/UnityEngine.Bounds",
"description": "Bounds of the GameObject."
},
"Hierarchy": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Runtime.Data.GameObjectMetadata",
"description": "Hierarchy metadata of the GameObject."
},
"Components": {
"$ref": "#/$defs/com.IvanMurzak.Unity.MCP.Runtime.Data.ComponentDataShallow[]",
"description": "Attached components shallow data of the GameObject (Read-only, use Component modification tool for modification)."
}
}
}
},
"required": [
"result"
]
}
tools
Generate all skills from the existed Tools in the Unity Project.
tools
Create a new skill using C# code. It will be added into the project as a .cs file and compiled by Unity. The skill will be available for use after compilation. It must be a partial class decorated with [McpPluginToolType]. Each tool method must be decorated with [McpPluginTool]. The class name should match the file name. All Unity API calls must use com.IvanMurzak.ReflectorNet.Utils.MainThread.Instance.Run(). Return a data model for structured output, or void for side-effect-only operations. Full sample: ```csharp #nullable enable using System; using System.ComponentModel; using com.IvanMurzak.McpPlugin; using com.IvanMurzak.ReflectorNet.Utils; using com.IvanMurzak.Unity.MCP.Editor.Utils; using com.IvanMurzak.Unity.MCP.Runtime.Data; using UnityEditor; using UnityEngine; namespace com.IvanMurzak.Unity.MCP.Editor.API { [McpPluginToolType] public partial class Tool_Sample { [McpPluginTool("sample-get", Title = "Sample / Get")] [Description("Finds a GameObject and returns its ref data.")] public GameObjectRef Get ( [Description("Name of the GameObject to find.")] string name ) { return MainThread.Instance.Run(() => { var go = GameObject.Find(name) ?? throw new ArgumentException($"GameObject '{name}' not found.", nameof(name)); return new GameObjectRef(go); }); } [McpPluginTool("sample-rename", Title = "Sample / Rename")] [Description("Renames a GameObject.")] public void Rename ( [Description("Current name of the GameObject.")] string name, [Description("New name to assign.")] string newName ) { MainThread.Instance.Run(() => { var go = GameObject.Find(name) ?? throw new ArgumentException($"GameObject '{name}' not found.", nameof(name)); go.name = newName; EditorUtility.SetDirty(go); AssetDatabase.Refresh(ImportAssetOptions.ForceSynchronousImport); EditorUtils.RepaintAllEditorWindows(); }); } } } ``` ## Suggestions ### Refresh UI after visual changes If the skill modifies anything visually in the Unity Editor (GameObjects, components, materials, etc.), call these two lines at the end of the tool method to apply changes to the UI immediately: ```csharp AssetDatabase.Refresh(ImportAssetOptions.ForceSynchronousImport); EditorUtils.RepaintAllEditorWindows(); ``` ### Refresh AssetDatabase after asset or script changes If the skill creates, modifies, or deletes any asset file or .cs script on disk outside of Unity API, call this inside a `MainThread.Instance.Run()` block to ensure Unity picks up the changes: ```csharp MainThread.Instance.Run(() => { AssetDatabase.Refresh(ImportAssetOptions.ForceSynchronousImport); }); ``` ### Use processing mechanic for long-running or domain-reload operations Some operations take time to complete and may trigger a Unity domain reload (e.g. writing a .cs script, switching play mode, running tests, adding a package). In these cases the tool must NOT block and wait — instead it must: 1. Accept a `[RequestID] string? requestId` parameter. 2. Return `ResponseCallTool.Processing("...").SetRequestID(requestId)` immediately. 3. Schedule the actual work asynchronously via `MainThread.Instance.RunAsync(async () => { await Task.Yield(); ... })`. 4. When the operation finishes, send the final result by calling: ```csharp _ = UnityMcpPluginEditor.NotifyToolRequestCompleted(new RequestToolCompletedData { RequestId = requestId, Result = ResponseCallTool.Success("Operation completed.").SetRequestID(requestId) }); ``` If the operation may survive a domain reload (e.g. a .cs file was saved and Unity will recompile), use `ScriptUtils.SchedulePostCompilationNotification(requestId, filePath, operationType)` instead of calling `NotifyToolRequestCompleted` directly — it persists the pending notification to `SessionState` and sends it automatically after the domain reload completes. For package install/removal or other non-compilation domain reloads use `PackageUtils.SchedulePostDomainReloadNotification(requestId, label, action, expectedResult)` the same way. ### Return structured data with a typed response Prefer returning a structured data model over a plain string so the AI can parse individual fields. Declare a nested class with `[Description]` on each property and use `ResponseCallValueTool<T>` as return type: ```csharp // Return type: public ResponseCallValueTool<MyResult> MyTool(...) { return ResponseCallValueTool<MyResult>.Success(new MyResult { Name = go.name, InstanceID = go.GetInstanceID() }).SetRequestID(requestId); } // Data model: public class MyResult { [Description("Name of the GameObject.")] public string? Name { get; set; } [Description("Unity instance ID of the GameObject.")] public int InstanceID { get; set; } } ``` For simpler cases that do not need async/processing, you may return the model directly (without `ResponseCallValueTool<T>`) and Unity-MCP will wrap it automatically. ### Validate inputs early and throw clearly Always validate required parameters at the top of the method before any Unity API calls. Throw `ArgumentException` or `InvalidOperationException` with descriptive messages so the AI knows exactly what went wrong and can self-correct: ```csharp if (string.IsNullOrEmpty(name)) throw new ArgumentException("Name cannot be null or empty.", nameof(name)); ``` ### Always use MainThread for Unity API calls All Unity API calls (including `GameObject.Find`, `AssetDatabase`, `EditorUtility`, etc.) MUST run on the main thread. Wrap them in `MainThread.Instance.Run(() => { ... })` for synchronous operations, or `MainThread.Instance.RunAsync(async () => { ... })` when you need to await inside.
tools
Provides an initial setup for AI Skills, `unity-mcp-cli` command line tool installation and everything else that is helpful to set up at the start of the project. Essential packages, and basic configurations.
data-ai
Generates a JSON Schema for a given C# type name using reflection. Supports primitives, enums, arrays, generic collections, dictionaries, and complex objects. The type must be present in any loaded assembly. Use the full type name (e.g. 'UnityEngine.Vector3') for best results.