Skip to main content
Glama

Add User Data Slot

add_user_data

Create a new User Data slot on any BaseList2D and get its DescID for use as a path in parameter reads or writes.

Instructions

Add a new User Data slot to any BaseList2D (common rigging / control-exposure pattern). Returns the slot's DescID (as a nested list) which can be piped into get_params / set_params as a path. dtype aliases: real, long, bool, vector, string, color, filename, time, link.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
maxNoNumeric upper bound (real / long).
minNoNumeric lower bound (real / long).
nameYesDisplay name for the new UD slot.
stepNoSpinner step size.
dtypeYesUser-data dtype.
valueNoInitial value. For vector / color, pass [x,y,z].
handleYesTarget (object / tag / material / etc.).
defaultNoDefault stored on the descriptor.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.5.1
    • removedInput schema / definitions
      Removed value: -{
      -  "__schema0": {
      -    "anyOf": [
      -      {
      -        "properties": {
      -          "kind": {
      -            "const": "object",
      -            "type": "string"
      -          },
      -          "name": {
      -            "type": "string"
      -          },
      -          "path": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "kind"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "kind": {
      -            "const": "render_data",
      -            "type": "string"
      -          },
      -          "name": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "kind",
      -          "name"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "kind": {
      -            "const": "take",
      -            "type": "string"
      -          },
      -          "name": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "kind",
      -          "name"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "kind": {
      -            "const": "material",
      -            "type": "string"
      -          },
      -          "name": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "kind",
      -          "name"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "kind": {
      -            "const": "layer",
      -            "type": "string"
      -          },
      -          "name": {
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "kind",
      -          "name"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "kind": {
      -            "const": "tag",
      -            "type": "string"
      -          },
      -          "object": {
      -            "type": "string"
      -          },
      -          "object_path": {
      -            "type": "string"
      -          },
      -          "tag_name": {
      -            "type": "string"
      -          },
      -          "type_id": {
      -            "maximum": 9007199254740991,
      -            "minimum": -9007199254740991,
      -            "type": "integer"
      -          }
      -        },
      -        "required": [
      -          "kind"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "kind": {
      -            "const": "video_post",
      -            "type": "string"
      -          },
      -          "render_data": {
      -            "type": "string"
      -          },
      -          "type_id": {
      -            "maximum": 9007199254740991,
      -            "minimum": -9007199254740991,
      -            "type": "integer"
      -          }
      -        },
      -        "required": [
      -          "kind",
      -          "render_data",
      -          "type_id"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "index": {
      -            "maximum": 9007199254740991,
      -            "minimum": 0,
      -            "type": "integer"
      -          },
      -          "kind": {
      -            "const": "shader",
      -            "type": "string"
      -          },
      -          "name": {
      -            "type": "string"
      -          },
      -          "owner": {
      -            "allOf": [
      -              {
      -                "$ref": "#/definitions/__schema0"
      -              }
      -            ]
      -          }
      -        },
      -        "required": [
      -          "kind",
      -          "owner"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "id": {
      -            "type": "string"
      -          },
      -          "kind": {
      -            "const": "gv_node",
      -            "type": "string"
      -          },
      -          "name": {
      -            "type": "string"
      -          },
      -          "tag": {
      -            "allOf": [
      -              {
      -                "$ref": "#/definitions/__schema0"
      -              }
      -            ]
      -          }
      -        },
      -        "required": [
      -          "kind",
      -          "tag"
      -        ],
      -        "type": "object"
      -      },
      -      {
      -        "properties": {
      -          "kind": {
      -            "const": "plugin_options",
      -            "type": "string"
      -          },
      -          "plugin_id": {
      -            "anyOf": [
      -              {
      -                "maximum": 9007199254740991,
      -                "minimum": -9007199254740991,
      -                "type": "integer"
      -              },
      -              {
      -                "type": "string"
      -              }
      -            ]
      -          },
      -          "plugin_type": {
      -            "enum": [
      -              "command",
      -              "object",
      -              "tag",
      -              "material",
      -              "shader",
      -              "video_post",
      -              "scene_loader",
      -              "scene_saver",
      -              "bitmap_loader",
      -              "bitmap_saver",
      -              "tool",
      -              "preference",
      -              "node",
      -              "sculpt_brush"
      -            ],
      -            "type": "string"
      -          }
      -        },
      -        "required": [
      -          "kind",
      -          "plugin_id"
      -        ],
      -        "type": "object"
      -      }
      -    ]
      -  }
      -}
    • removedInput schema / properties / handle / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/definitions/__schema0"
      -  }
      -]
    • addedInput schema / properties / handle / anyOf
      Added value: +[
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "object",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      },
      +      "path": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "render_data",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "take",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "material",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "layer",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "tag",
      +        "type": "string"
      +      },
      +      "object": {
      +        "type": "string"
      +      },
      +      "object_path": {
      +        "type": "string"
      +      },
      +      "tag_name": {
      +        "type": "string"
      +      },
      +      "type_id": {
      +        "maximum": 9007199254740991,
      +        "minimum": -9007199254740991,
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "video_post",
      +        "type": "string"
      +      },
      +      "render_data": {
      +        "type": "string"
      +      },
      +      "type_id": {
      +        "maximum": 9007199254740991,
      +        "minimum": -9007199254740991,
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "render_data",
      +      "type_id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "plugin_options",
      +        "type": "string"
      +      },
      +      "plugin_id": {
      +        "anyOf": [
      +          {
      +            "maximum": 9007199254740991,
      +            "minimum": -9007199254740991,
      +            "type": "integer"
      +          },
      +          {
      +            "type": "string"
      +          }
      +        ]
      +      },
      +      "plugin_type": {
      +        "enum": [
      +          "command",
      +          "object",
      +          "tag",
      +          "material",
      +          "shader",
      +          "video_post",
      +          "scene_loader",
      +          "scene_saver",
      +          "bitmap_loader",
      +          "bitmap_saver",
      +          "tool",
      +          "preference",
      +          "node",
      +          "sculpt_brush"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "plugin_id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "index": {
      +        "maximum": 9007199254740991,
      +        "minimum": 0,
      +        "type": "integer"
      +      },
      +      "kind": {
      +        "const": "shader",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      },
      +      "owner": {
      +        "additionalProperties": {},
      +        "description": "Handle of the shader's owner (material, object, tag, video_post, or shader).",
      +        "properties": {
      +          "kind": {
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "kind"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "owner"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "id": {
      +        "type": "string"
      +      },
      +      "kind": {
      +        "const": "gv_node",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      },
      +      "tag": {
      +        "properties": {
      +          "kind": {
      +            "const": "tag",
      +            "type": "string"
      +          },
      +          "object": {
      +            "type": "string"
      +          },
      +          "object_path": {
      +            "type": "string"
      +          },
      +          "tag_name": {
      +            "type": "string"
      +          },
      +          "type_id": {
      +            "maximum": 9007199254740991,
      +            "minimum": -9007199254740991,
      +            "type": "integer"
      +          }
      +        },
      +        "required": [
      +          "kind"
      +        ],
      +        "type": "object"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "tag"
      +    ],
      +    "type": "object"
      +  }
      +]
  2. Changed1 schema field changedv0.4.3
    • changedInput schema / definitions / __schema0 / anyOf
      Previous value: -[
      -  {
      -    "properties": {
      -      "kind": {
      -        "const": "object",
      -        "type": "string"
      -      },
      -      "name": {
      -        "type": "string"
      -      },
      -      "path": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "kind": {
      -        "const": "render_data",
      -        "type": "string"
      -      },
      -      "name": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "name"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "kind": {
      -        "const": "take",
      -        "type": "string"
      -      },
      -      "name": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "name"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "kind": {
      -        "const": "material",
      -        "type": "string"
      -      },
      -      "name": {
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "name"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "kind": {
      -        "const": "tag",
      -        "type": "string"
      -      },
      -      "object": {
      -        "type": "string"
      -      },
      -      "object_path": {
      -        "type": "string"
      -      },
      -      "tag_name": {
      -        "type": "string"
      -      },
      -      "type_id": {
      -        "maximum": 9007199254740991,
      -        "minimum": -9007199254740991,
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "kind"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "kind": {
      -        "const": "video_post",
      -        "type": "string"
      -      },
      -      "render_data": {
      -        "type": "string"
      -      },
      -      "type_id": {
      -        "maximum": 9007199254740991,
      -        "minimum": -9007199254740991,
      -        "type": "integer"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "render_data",
      -      "type_id"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "index": {
      -        "maximum": 9007199254740991,
      -        "minimum": 0,
      -        "type": "integer"
      -      },
      -      "kind": {
      -        "const": "shader",
      -        "type": "string"
      -      },
      -      "name": {
      -        "type": "string"
      -      },
      -      "owner": {
      -        "allOf": [
      -          {
      -            "$ref": "#/definitions/__schema0"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "owner"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "id": {
      -        "type": "string"
      -      },
      -      "kind": {
      -        "const": "gv_node",
      -        "type": "string"
      -      },
      -      "name": {
      -        "type": "string"
      -      },
      -      "tag": {
      -        "allOf": [
      -          {
      -            "$ref": "#/definitions/__schema0"
      -          }
      -        ]
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "tag"
      -    ],
      -    "type": "object"
      -  },
      -  {
      -    "properties": {
      -      "kind": {
      -        "const": "plugin_options",
      -        "type": "string"
      -      },
      -      "plugin_id": {
      -        "anyOf": [
      -          {
      -            "maximum": 9007199254740991,
      -            "minimum": -9007199254740991,
      -            "type": "integer"
      -          },
      -          {
      -            "type": "string"
      -          }
      -        ]
      -      },
      -      "plugin_type": {
      -        "enum": [
      -          "command",
      -          "object",
      -          "tag",
      -          "material",
      -          "shader",
      -          "video_post",
      -          "scene_loader",
      -          "scene_saver",
      -          "bitmap_loader",
      -          "bitmap_saver",
      -          "tool",
      -          "preference",
      -          "node",
      -          "sculpt_brush"
      -        ],
      -        "type": "string"
      -      }
      -    },
      -    "required": [
      -      "kind",
      -      "plugin_id"
      -    ],
      -    "type": "object"
      -  }
      -]New value: +[
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "object",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      },
      +      "path": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "render_data",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "take",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "material",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "layer",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "name"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "tag",
      +        "type": "string"
      +      },
      +      "object": {
      +        "type": "string"
      +      },
      +      "object_path": {
      +        "type": "string"
      +      },
      +      "tag_name": {
      +        "type": "string"
      +      },
      +      "type_id": {
      +        "maximum": 9007199254740991,
      +        "minimum": -9007199254740991,
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "kind"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "video_post",
      +        "type": "string"
      +      },
      +      "render_data": {
      +        "type": "string"
      +      },
      +      "type_id": {
      +        "maximum": 9007199254740991,
      +        "minimum": -9007199254740991,
      +        "type": "integer"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "render_data",
      +      "type_id"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "index": {
      +        "maximum": 9007199254740991,
      +        "minimum": 0,
      +        "type": "integer"
      +      },
      +      "kind": {
      +        "const": "shader",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      },
      +      "owner": {
      +        "allOf": [
      +          {
      +            "$ref": "#/definitions/__schema0"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "owner"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "id": {
      +        "type": "string"
      +      },
      +      "kind": {
      +        "const": "gv_node",
      +        "type": "string"
      +      },
      +      "name": {
      +        "type": "string"
      +      },
      +      "tag": {
      +        "allOf": [
      +          {
      +            "$ref": "#/definitions/__schema0"
      +          }
      +        ]
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "tag"
      +    ],
      +    "type": "object"
      +  },
      +  {
      +    "properties": {
      +      "kind": {
      +        "const": "plugin_options",
      +        "type": "string"
      +      },
      +      "plugin_id": {
      +        "anyOf": [
      +          {
      +            "maximum": 9007199254740991,
      +            "minimum": -9007199254740991,
      +            "type": "integer"
      +          },
      +          {
      +            "type": "string"
      +          }
      +        ]
      +      },
      +      "plugin_type": {
      +        "enum": [
      +          "command",
      +          "object",
      +          "tag",
      +          "material",
      +          "shader",
      +          "video_post",
      +          "scene_loader",
      +          "scene_saver",
      +          "bitmap_loader",
      +          "bitmap_saver",
      +          "tool",
      +          "preference",
      +          "node",
      +          "sculpt_brush"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "plugin_id"
      +    ],
      +    "type": "object"
      +  }
      +]
  3. First observedv0.3.1

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations, so the description carries the full burden, and it does disclose the key behavioral fact: the tool returns a nested-list DescID usable as a path in get_params/set_params. It also enumerates the dtype aliases, which tells the agent the accepted type universe. It does not say what happens on duplicate names, whether it mutates the scene, or that it is irreversible, which would have pushed it to a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences: the first states what the tool does, the second states the return value and how to use it. The dtype alias list is brief and formatted as a single comma-separated string. No filler, front-loaded.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 8-parameter mutation tool with 100% schema coverage but no annotations and no output schema, the description covers the essentials: target class, return value, and dtype vocabulary. It omits duplicate-name behavior and confirmation of persistence, minor but real gaps. Overall sufficient for correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3 and the schema already documents max/min/step/default/value. The description earns above baseline by listing the dtype aliases explicitly, which gives the agent a quick pre-parse list of valid values without unrolling the schema enum. It does not add meaning to the handle variants, but those are richly described in the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (Add) and resource (a new User Data slot on any BaseList2D), and parenthetically names the use case (rigging / control-exposure pattern). Sibling tools remove_user_data and list_user_data make the create semantics unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Names the target class (any BaseList2D) and explains what to do with the result: pipe the returned DescID into get_params/set_params. This is real routing guidance. It does not, however, name remove_user_data/list_user_data or state when not to use it (e.g., if a slot of that name already exists), so it stops short of full when/when-not coverage.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.