A parameter for the tool whose value should be set at config time.

Example Usage

import { StaticToolParameter } from "syllable-sdk/models/components";

let value: StaticToolParameter = {
  name: "<value>",
  required: false,
  type: "data_source_list",
};

Fields

FieldTypeRequiredDescription
namestringTRUEThe name of the parameter - must be unique within the tool.
descriptionstringFALSEThe description of the parameter.
requiredbooleanTRUEWhether the parameter is required to have a value assigned.
typecomponents.StaticToolParameterTypeTRUEThe expected type for a static tool parameter.
defaultanyFALSEThe default value for the parameter. If type is string, must be a string. If type is int, must be an int. If type is boolean, must be a boolean. If type is data_source_list, must be a list of strings (data source names).