Scene Describe
scene_describeDescribes a Maya node at the API level: exact type, attribute metadata, and connection wiring. Use this to compose accurate script commands against real names.
Instructions
API-level self-description of ONE node (not spatial).
Boundary: scene_inspect answers WHERE an object is (position, bbox, neighbors); scene_describe answers WHAT the node is at the API level - exact node type, per-attribute metadata, and connection wiring - so you can compose accurate execute_code/setAttr/connectAttr calls against real names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| node | Yes | Node name (short name or long DAG path). | |
| attrs | No | Attribute names to describe; None (default) lists every attribute listAttr reports UP TO the response budget (limit) - over-budget output is truncated and disclosed via attrs_truncated + total_count, never silent; narrow further with an explicit attrs list or raise limit and re-query. A named attr that does not exist aborts the whole call (attr_not_found) - no partial metadata (same contract as scene_export's missing_objects). | |
| limit | No | Max items returned per face (attrs and connections). Soft default 200; a caller may relax explicitly to the hard cap 1000 (D-110) - bounds response size only, not the per-attribute query cost. | |
| session_key | No | Maya session key (auto-selected if one session). | |
| include_values | No | Also return value + soft_min/soft_max per attr (default False). Reading a value can trigger DG evaluation inside Maya - still read-only, but the eval may cost time on heavy graphs. | |
| include_connections | No | Return connection wiring {src_plug, dst_plug, direction} (default True); the same budget applies (connections_truncated + total_connections; no cursor in v1 - narrow and re-query). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |