McpPromptFunctionOptions interface

Configuration options for an MCP Prompt function. This includes trigger-specific options and general function options.

Extends

Properties

handler

The handler function to execute when the trigger is invoked.

trigger

The trigger configuration for the MCP Prompt.

Inherited Properties

description

Optional description of the prompt.

extraInputs

Configuration for an optional set of secondary inputs During invocation, get these values with context.extraInputs.get()

extraOutputs

Configuration for an optional set of secondary outputs During invocation, set these values with context.extraOutputs.set()

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.

return

Configuration for the optional primary output of the function This is the main output that you should set as the return value of the function handler during invocation

title

Optional human-readable title for display purposes.

Property Details

handler

The handler function to execute when the trigger is invoked.

handler: McpPromptTriggerHandler<T>

Property Value

trigger

The trigger configuration for the MCP Prompt.

trigger?: McpPromptTrigger

Property Value

Inherited Property Details

description

Optional description of the prompt.

description?: string

Property Value

string

Inherited From McpPromptTriggerOptions.description

extraInputs

Configuration for an optional set of secondary inputs During invocation, get these values with context.extraInputs.get()

extraInputs?: FunctionInput[]

Property Value

Inherited From Partial.extraInputs

extraOutputs

Configuration for an optional set of secondary outputs During invocation, set these values with context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

Property Value

Inherited From Partial.extraOutputs

icons

Optional JSON-serialized array of icon objects.

icons?: string

Property Value

string

Inherited From McpPromptTriggerOptions.icons

metadata

Optional JSON-serialized metadata object.

metadata?: string

Property Value

string

Inherited From McpPromptTriggerOptions.metadata

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

Inherited From McpPromptTriggerOptions.promptArguments

promptName

Unique name of the prompt.

promptName: string

Property Value

string

Inherited From McpPromptTriggerOptions.promptName

return

Configuration for the optional primary output of the function This is the main output that you should set as the return value of the function handler during invocation

return?: FunctionOutput

Property Value

Inherited From Partial.return

title

Optional human-readable title for display purposes.

title?: string

Property Value

string

Inherited From McpPromptTriggerOptions.title