scene-get-data

Scene / Get Data

This tool retrieves the list of root GameObjects in the specified scene. Use 'scene-list-opened' tool to get the list of all opened scenes.

Toggles (all default false to keep responses small)

• includeRootGameObjects — include root GameObjects in the scene data.
• includeChildrenDepth (default 3) — depth of the hierarchy to include.
• includeBounds — include 3D bounds for GameObjects.
• includeData — include serialized component data for GameObjects.

Path-scoped reads (token-saving)

Supply paths to read only the listed fields/elements from the scene's root-GameObjects array via Reflector.TryReadAt, or viewQuery to navigate/filter the same array via Reflector.View. The result populates Data on the returned SceneData. These two parameters are mutually exclusive.

Path syntax

fieldName, nested/field, arrayField/[i], dictField/[key]. Leading #/ is stripped. Example: paths=['[0]/name'] reads the name of the first root GameObject.

How to Call

unity-mcp-cli run-tool scene-get-data --input '{
  "openedSceneName": "string_value",
  "includeRootGameObjects": false,
  "includeChildrenDepth": 0,
  "includeBounds": false,
  "includeData": 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 scene-get-data --input-file args.json

Or pipe via stdin (recommended):

unity-mcp-cli run-tool scene-get-data --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.

Input

Name	Type	Required	Description
openedSceneName	string	No	Name of the opened scene. If empty or null, the active scene will be used.
includeRootGameObjects	boolean	No	If true, includes root GameObjects in the scene data.
includeChildrenDepth	integer	No	Determines the depth of the hierarchy to include.
includeBounds	boolean	No	If true, includes bounding box information for GameObjects.
includeData	boolean	No	If true, includes component data for GameObjects.
paths	any	No	Optional. List of paths to read individually via Reflector.TryReadAt against the scene's root-GameObjects array. Path syntax: 'fieldName', '[i]/field', '[i]/component/[j]/property'. Mutually exclusive with 'viewQuery'.
viewQuery	any	No	Optional. View-query filter routed through Reflector.View on the scene's root-GameObjects array. Mutually exclusive with 'paths'.