Skip to main content

parameter

Parameter Model​

Defines a parameter used in tools, including metadata about its identity, purpose, and constraints.

id (integer, Read-only)​

Unique identifier of the parameter.

name (string) Required​

The name of the parameter.

  • Min length: 1

description (string) Required​

A description explaining the purpose or expected content of the parameter.

  • Min length: 1

type (string) Required​

The data type of the parameter.

  • Min length: 1

required (boolean) Required​

Indicates whether this parameter must be provided for the tool to function.

Example​

{
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
}