IToolPropertyBuilder interface
Interfaz para el constructor de API Fluent para crear propiedades de la herramienta MCP Esto actúa como puente entre la implementación y las declaraciones de tipo
- Extends
-
Omit<Arg, never>
Propiedades
| description | Descripción de la propiedad. Esto proporciona contexto adicional sobre el propósito o uso de la propiedad. |
| is |
Indica si la propiedad es un tipo de matriz. |
| is |
Indica si la propiedad es requerida. |
| property |
Tipo de la propiedad. |
Métodos
| as |
Marque la propiedad como un tipo de matriz |
| boolean() | Establecer el tipo de propiedad como booleano |
| datetime() | Establecer el tipo de propiedad a datetime |
| describe(string) | Establecer la descripción de la propiedad |
| double() | Configura el tipo de propiedad a doble |
| integer() | Establecer el tipo de propiedad en entero |
| long() | Establecer el tipo de propiedad a largo |
| number() | Establecer el tipo de propiedad a número |
| object() | Establecer el tipo de propiedad a objeto |
| optional() | Marque la propiedad como opcional |
| string() | Establecer el tipo de propiedad a cadena |
Detalles de las propiedades
description
Descripción de la propiedad. Esto proporciona contexto adicional sobre el propósito o uso de la propiedad.
description: string
Valor de propiedad
string
isArray
Indica si la propiedad es un tipo de matriz.
isArray: boolean
Valor de propiedad
boolean
isRequired
Indica si la propiedad es requerida.
isRequired: boolean
Valor de propiedad
boolean
propertyType
Tipo de la propiedad.
propertyType: string
Valor de propiedad
string
Detalles del método
asArray()
Marque la propiedad como un tipo de matriz
function asArray(): IToolPropertyBuilder
Devoluciones
boolean()
Establecer el tipo de propiedad como booleano
function boolean(): IToolPropertyBuilder
Devoluciones
datetime()
Establecer el tipo de propiedad a datetime
function datetime(): IToolPropertyBuilder
Devoluciones
describe(string)
Establecer la descripción de la propiedad
function describe(description: string): IToolPropertyBuilder
Parámetros
- description
-
string
Descripción del propósito de la propiedad
Devoluciones
double()
Configura el tipo de propiedad a doble
function double(): IToolPropertyBuilder
Devoluciones
integer()
Establecer el tipo de propiedad en entero
function integer(): IToolPropertyBuilder
Devoluciones
long()
Establecer el tipo de propiedad a largo
function long(): IToolPropertyBuilder
Devoluciones
number()
Establecer el tipo de propiedad a número
function number(): IToolPropertyBuilder
Devoluciones
object()
Establecer el tipo de propiedad a objeto
function object(): IToolPropertyBuilder
Devoluciones
optional()
Marque la propiedad como opcional
function optional(): IToolPropertyBuilder
Devoluciones
string()
Establecer el tipo de propiedad a cadena
function string(): IToolPropertyBuilder