gameobject-component-get

GameObject / Component / Get

Get detailed information about a specific Component on a GameObject. Returns component type, enabled state, and optionally serialized fields and properties. Use this to inspect component data before modifying it. Use 'gameobject-find' tool to get the list of all components on the GameObject.

Inputs

• gameObjectRef — the host GameObject.
• componentRef — the specific component to inspect (matched by index or instance ID).
• includeFields (default true) — populate the legacy Fields list.
• includeProperties (default true) — populate the legacy Properties list.
• deepSerialization (default false) — when populating legacy lists, recurse into nested members.

Path-scoped reads (token-saving)

Supply paths (a list of paths) to read only the listed fields/elements via Reflector.TryReadAt, or viewQuery (a ViewQuery) to navigate to a subtree and/or filter by name regex / max depth / type via Reflector.View. The result is returned in the View field of the response, and the legacy Fields/Properties lists are skipped. These two parameters are mutually exclusive — supply at most one.

Path syntax

fieldName, nested/field, arrayField/[i], dictField/[key]. Leading #/ is stripped.

How to Call

unity-mcp-cli run-tool gameobject-component-get --input '{
  "gameObjectRef": "string_value",
  "componentRef": "string_value",
  "includeFields": false,
  "includeProperties": false,
  "deepSerialization": false,
  "paths": "string_value",
  "viewQuery": "string_value"
}'

For complex input (multi-line strings, code), save the JSON to a file and use:

unity-mcp-cli run-tool gameobject-component-get --input-file args.json

Or pipe via stdin (recommended):

unity-mcp-cli run-tool gameobject-component-get --input-file - <<'EOF'
{"param": "value"}
EOF

Troubleshooting

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.