Skip to main content
Glama

Get Parameter Values

get_params
Read-only

Retrieve parameter values from Cinema 4D entities by ID or DescID path, returning each value in the order requested.

Instructions

Read parameter values on a C4D entity by id or DescID path. Each id may be: an int (top-level), a list [a, b, …] (chained DescID; dtypes inferred from the description), or contain 'x'/'y'/'z' for vector sub-components (e.g. [903, 'x'] = position.x). For explicit dtypes use [[id, 'real|long|bool|vector'], …]. Returns {values: [{path, value}]} in request order. Discover ids via describe.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsYesList of parameter paths to read.
handleYesC4D entity handle. Shapes: {kind:"object",name?|path?}, {kind:"render_data",name}, {kind:"take",name}, {kind:"material",name}, {kind:"layer",name}, {kind:"tag",object?|object_path?,type_id?,tag_name?}, {kind:"video_post",render_data,type_id}, {kind:"shader",owner:<handle>,index}, {kind:"gv_node",tag:<tag handle>,id?|name?} (Xpresso GvNode; use list_xpresso_nodes to discover stable path ids — GvNode inherits BaseList2D so set_params/get_params/describe work on it), {kind:"plugin_options",plugin_id,plugin_type?} (plugin_id accepts an int or a format alias like "abc"/"fbx"/"obj"/"usd"/"gltf"; plugin_type defaults to "scene_saver"; resolves to the plugin's settings BaseList2D — describe+set_params it to configure exporter options before save_document). Prefer `path` over `name` when names are not unique.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 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"
      +  }
      +]
    • changedInput schema / properties / ids / items / anyOf
      Previous value: -[
      -  {
      -    "maximum": 9007199254740991,
      -    "minimum": -9007199254740991,
      -    "type": "integer"
      -  },
      -  {
      -    "items": {
      -      "anyOf": [
      -        {
      -          "maximum": 9007199254740991,
      -          "minimum": -9007199254740991,
      -          "type": "integer"
      -        },
      -        {
      -          "enum": [
      -            "x",
      -            "y",
      -            "z"
      -          ],
      -          "type": "string"
      -        },
      -        {
      -          "items": [
      -            {
      -              "anyOf": [
      -                {
      -                  "maximum": 9007199254740991,
      -                  "minimum": -9007199254740991,
      -                  "type": "integer"
      -                },
      -                {
      -                  "enum": [
      -                    "x",
      -                    "y",
      -                    "z"
      -                  ],
      -                  "type": "string"
      -                }
      -              ]
      -            },
      -            {
      -              "type": "string"
      -            }
      -          ],
      -          "type": "array"
      -        },
      -        {
      -          "items": {
      -            "maximum": 9007199254740991,
      -            "minimum": -9007199254740991,
      -            "type": "integer"
      -          },
      -          "maxItems": 3,
      -          "minItems": 2,
      -          "type": "array"
      -        }
      -      ]
      -    },
      -    "minItems": 1,
      -    "type": "array"
      -  }
      -]New value: +[
      +  {
      +    "maximum": 9007199254740991,
      +    "minimum": -9007199254740991,
      +    "type": "integer"
      +  },
      +  {
      +    "items": {
      +      "anyOf": [
      +        {
      +          "maximum": 9007199254740991,
      +          "minimum": -9007199254740991,
      +          "type": "integer"
      +        },
      +        {
      +          "enum": [
      +            "x",
      +            "y",
      +            "z"
      +          ],
      +          "type": "string"
      +        },
      +        {
      +          "items": {
      +            "anyOf": [
      +              {
      +                "maximum": 9007199254740991,
      +                "minimum": -9007199254740991,
      +                "type": "integer"
      +              },
      +              {
      +                "type": "string"
      +              }
      +            ]
      +          },
      +          "maxItems": 2,
      +          "minItems": 2,
      +          "type": "array"
      +        },
      +        {
      +          "items": {
      +            "maximum": 9007199254740991,
      +            "minimum": -9007199254740991,
      +            "type": "integer"
      +          },
      +          "maxItems": 3,
      +          "minItems": 2,
      +          "type": "array"
      +        }
      +      ]
      +    },
      +    "minItems": 1,
      +    "type": "array"
      +  }
      +]
  2. Changed2 schema fields 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"
      +  }
      +]
    • changedInput schema / properties / handle / description
      Previous value: -"C4D entity handle. Shapes: {kind:\"object\",name?|path?}, {kind:\"render_data\",name}, {kind:\"take\",name}, {kind:\"material\",name}, {kind:\"tag\",object?|object_path?,type_id?,tag_name?}, {kind:\"video_post\",render_data,type_id}, {kind:\"shader\",owner:<handle>,index}, {kind:\"gv_node\",tag:<tag handle>,id?|name?} (Xpresso GvNode; use list_xpresso_nodes to discover stable path ids — GvNode inherits BaseList2D so set_params/get_params/describe work on it), {kind:\"plugin_options\",plugin_id,plugin_type?} (plugin_id accepts an int or a format alias like \"abc\"/\"fbx\"/\"obj\"/\"usd\"/\"gltf\"; plugin_type defaults to \"scene_saver\"; resolves to the plugin's settings BaseList2D — describe+set_params it to configure exporter options before save_document). Prefer `path` over `name` when names are not unique."New value: +"C4D entity handle. Shapes: {kind:\"object\",name?|path?}, {kind:\"render_data\",name}, {kind:\"take\",name}, {kind:\"material\",name}, {kind:\"layer\",name}, {kind:\"tag\",object?|object_path?,type_id?,tag_name?}, {kind:\"video_post\",render_data,type_id}, {kind:\"shader\",owner:<handle>,index}, {kind:\"gv_node\",tag:<tag handle>,id?|name?} (Xpresso GvNode; use list_xpresso_nodes to discover stable path ids — GvNode inherits BaseList2D so set_params/get_params/describe work on it), {kind:\"plugin_options\",plugin_id,plugin_type?} (plugin_id accepts an int or a format alias like \"abc\"/\"fbx\"/\"obj\"/\"usd\"/\"gltf\"; plugin_type defaults to \"scene_saver\"; resolves to the plugin's settings BaseList2D — describe+set_params it to configure exporter options before save_document). Prefer `path` over `name` when names are not unique."
  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?

Annotations already declare readOnlyHint=true, so safety is covered. The description adds real behavioral value beyond that: it specifies the return shape `{values: [{path, value}]}` in request order and the dtype-inference behavior, which the annotations do not carry.

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

Conciseness4/5

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

Front-loads the core purpose, then packs id formats, dtypes, and return shape into dense but non-redundant sentences. Every clause earns its place, though the id-format enumeration is dense enough to require careful reading.

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

Completeness5/5

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

No output schema exists, so the description carries the return-value burden and does so explicitly. Combined with the return shape, dtype rules, and the describe pointer, an agent has everything needed to call it correctly.

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 schema already documents the id/handle types. The description nevertheless adds meaning the schema doesn't: the int vs chained-list vs x/y/z sub-component semantics, the explicit dtype escape hatch, and the position.x example. This is above the baseline 3 for high-coverage schemas.

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+resource ('Read parameter values on a C4D entity') and implicitly contrasts with set_params (write) and describe (discovery). An agent can distinguish it from the write sibling and the discovery sibling without opening schemas.

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?

Explicitly routes the agent to `describe` for discovering ids, which is the key prerequisite before calling this tool. It stops short of naming when-not-to-use conditions (e.g. vs set_params or get_container), so it's clear context but not full when/when-not/alternatives coverage.

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