McpToolTriggerOptions interface

Configuration options for an MCP Tool trigger. These options define the behavior and metadata for the trigger.

Properties

description

A description of the tool or trigger. This provides additional context about the trigger's purpose.

metadata

JSON-serialized metadata object. Additional metadata about the tool in JSON format.

resultSchema

Optional JSON-serialized JSON Schema describing the structured result of this tool.

When provided, the value is validated as JSON and sent alongside useResultSchema: true so MCP clients that support structured content can use the declared schema.

toolName

The name of the tool associated with the trigger. This is typically an app setting or environment variable.

toolProperties

Additional properties or metadata for the tool. Can be provided as an array or as a Args object format.

Property Details

description

A description of the tool or trigger. This provides additional context about the trigger's purpose.

description: string

Property Value

string

metadata

JSON-serialized metadata object. Additional metadata about the tool in JSON format.

metadata?: string

Property Value

string

resultSchema

Optional JSON-serialized JSON Schema describing the structured result of this tool.

When provided, the value is validated as JSON and sent alongside useResultSchema: true so MCP clients that support structured content can use the declared schema.

resultSchema?: string

Property Value

string

toolName

The name of the tool associated with the trigger. This is typically an app setting or environment variable.

toolName: string

Property Value

string

toolProperties

Additional properties or metadata for the tool. Can be provided as an array or as a Args object format.

toolProperties?: McpToolProperty[] | Args

Property Value