McpResourceTriggerOptions interface

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

Properties

description

Description of the resource. Provides additional context about what the resource represents.

metadata

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

mimeType

MIME type of the resource content. Specifies the format of the resource data (e.g., 'application/json', 'text/plain').

resourceName

Human-readable name of the resource. This name is displayed to users in MCP client interfaces.

size

Optional size in bytes. The expected size of the resource content, if known.

title

Optional title for display purposes. A more descriptive title that can be shown in UI elements.

uri

Unique URI identifier for the resource (must be absolute). This is the canonical identifier used by MCP clients to reference the resource.

Property Details

description

Description of the resource. Provides additional context about what the resource represents.

description?: string

Property Value

string

metadata

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

metadata?: string

Property Value

string

mimeType

MIME type of the resource content. Specifies the format of the resource data (e.g., 'application/json', 'text/plain').

mimeType?: string

Property Value

string

resourceName

Human-readable name of the resource. This name is displayed to users in MCP client interfaces.

resourceName: string

Property Value

string

size

Optional size in bytes. The expected size of the resource content, if known.

size?: number

Property Value

number

title

Optional title for display purposes. A more descriptive title that can be shown in UI elements.

title?: string

Property Value

string

uri

Unique URI identifier for the resource (must be absolute). This is the canonical identifier used by MCP clients to reference the resource.

uri: string

Property Value

string