ElicitParams

Params of the elicitation/create request (client/elicitation).

The schema models the params as a union of a form variant and a URL variant (ElicitRequestParams = ElicitRequestFormParams | ElicitRequestURLParams). This struct holds the union of both shapes: mode is "form" (the default, when absent) or "url". Form-mode requests carry message and a requestedSchema (a restricted JSON Schema object the handler fills in); URL-mode requests (2025-11-25+) carry message, url, and elicitationId for an out-of-band interaction and leave requestedSchema undefined. The raw request Json is preserved in raw so a handler can inspect any field the typed view does not surface.

Members

Functions

isUrl
bool isUrl()

True for a URL-mode request (mode == "url").

Variables

elicitationId
string elicitationId;

url mode: correlates the request with its outcome

message
string message;

human-readable prompt shown to the user

mode
string mode;

"form" (default) or "url"

raw
Json raw;

the full request params as received

requestedSchema
Json requestedSchema;

form mode: the restricted JSON Schema

url
string url;

url mode: the URL the user completes out-of-band