McpPromptTriggerOptions interface

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

Properties

description

Optional description of the prompt.

icons

Optional JSON-serialized array of icon objects.

metadata

Optional JSON-serialized metadata object.

promptArguments

Optional list of arguments the prompt accepts.

Supports two shapes:

  • An array of McpPromptArgument objects (explicit name/description/required).
  • A record/fluent map built with promptArg.describe(...) where keys are argument names.
promptName

Unique name of the prompt.

title

Optional human-readable title for display purposes.

Property Details

description

Optional description of the prompt.

description?: string

Property Value

string

icons

Optional JSON-serialized array of icon objects.

icons?: string

Property Value

string

metadata

Optional JSON-serialized metadata object.

metadata?: string

Property Value

string

promptArguments

Optional list of arguments the prompt accepts.

Supports two shapes:

  • An array of McpPromptArgument objects (explicit name/description/required).
  • A record/fluent map built with promptArg.describe(...) where keys are argument names.
promptArguments?: McpPromptArguments

Property Value

promptName

Unique name of the prompt.

promptName: string

Property Value

string

title

Optional human-readable title for display purposes.

title?: string

Property Value

string