McpToolFunctionOptions interface
Opciones de configuración para una función de la herramienta MCP. Esto incluye opciones específicas de disparador y opciones generales de funciones.
- Extends
-
McpToolTriggerOptions,Partial<FunctionOptions>
Propiedades
| handler | La función de manejador que se ejecutará cuando se invoca el disparador. |
| trigger | La configuración del disparador para la herramienta MCP. |
Propiedades heredadas
| description | Una descripción de la herramienta o del disparador. Esto proporciona contexto adicional sobre el propósito del desencadenante. |
| extra |
Configuración de un conjunto opcional de entradas secundarias Durante la invocación, obtenga estos valores con |
| extra |
Configuración de un conjunto opcional de salidas secundarias Durante la invocación, establezca estos valores con |
| metadata | Objeto de metadatos serializados en JSON. Metadatos adicionales sobre la herramienta en formato JSON. |
| result |
Esquema JSON serializado opcional que describe el resultado estructurado de esta herramienta. Cuando se proporciona, el valor se valida como JSON y se envía junto |
| return | Configuración para la salida principal opcional de la función Esta es la salida principal que debe establecer como el valor devuelto del controlador de función durante la invocación. |
| tool |
El nombre de la herramienta asociada al disparador. Esto suele ser una variable de configuración de aplicación o de entorno. |
| tool |
Propiedades o metadatos adicionales para la herramienta. Puede proporcionarse como un array o como un formato de objeto Args. |
Detalles de las propiedades
handler
La función de manejador que se ejecutará cuando se invoca el disparador.
handler: McpToolTriggerHandler<T>
Valor de propiedad
trigger
La configuración del disparador para la herramienta MCP.
trigger?: McpToolTrigger
Valor de propiedad
Detalles de las propiedades heredadas
description
Una descripción de la herramienta o del disparador. Esto proporciona contexto adicional sobre el propósito del desencadenante.
description: string
Valor de propiedad
string
Heredado deMcpToolTriggerOptions.description
extraInputs
Configuración de un conjunto opcional de entradas secundarias Durante la invocación, obtenga estos valores con context.extraInputs.get()
extraInputs?: FunctionInput[]
Valor de propiedad
Heredado de Partial.extraInputs
extraOutputs
Configuración de un conjunto opcional de salidas secundarias Durante la invocación, establezca estos valores con context.extraOutputs.set()
extraOutputs?: FunctionOutput[]
Valor de propiedad
Heredado de Partial.extraOutputs
metadata
Objeto de metadatos serializados en JSON. Metadatos adicionales sobre la herramienta en formato JSON.
metadata?: string
Valor de propiedad
string
Heredado deMcpToolTriggerOptions.metadata
resultSchema
Esquema JSON serializado opcional que describe el resultado estructurado de esta herramienta.
Cuando se proporciona, el valor se valida como JSON y se envía junto useResultSchema: true con ello para que los clientes MCP que soporten contenido estructurado puedan utilizar el esquema declarado.
resultSchema?: string
Valor de propiedad
string
Heredado deMcpToolTriggerOptions.resultSchema
return
Configuración para la salida principal opcional de la función Esta es la salida principal que debe establecer como el valor devuelto del controlador de función durante la invocación.
return?: FunctionOutput
Valor de propiedad
Heredado de Partial.return
toolName
El nombre de la herramienta asociada al disparador. Esto suele ser una variable de configuración de aplicación o de entorno.
toolName: string
Valor de propiedad
string
Heredado deMcpToolTriggerOptions.toolName
toolProperties
Propiedades o metadatos adicionales para la herramienta. Puede proporcionarse como un array o como un formato de objeto Args.
toolProperties?: McpToolProperty[] | Args
Valor de propiedad
McpToolProperty[] | Args
Heredado deMcpToolTriggerOptions.toolProperties