Helper module used to build the params of an elicitation/create request
in URL mode: the user is sent to a web page, the data never passes
through the client.
(MCP protocol: 2025-11-25)
url must be an absolute http or https URL without credentials
(https://user:pass@host/ is rejected: clients show the URL to the user). elicitationId
identifies the interaction (the server sends
notifications/elicitation/complete with it).
Short example:
%ElicitRequestURLParams{}
|> ElicitRequestURLParams.message("Authorize the access")
|> ElicitRequestURLParams.url("https://example.com/authorize")
|> ElicitRequestURLParams.elicitation_id("e-1")
|> ElicitRequestURLParams.build()Result:
%{
mode: "url",
message: "Authorize the access",
url: "https://example.com/authorize",
elicitationId: "e-1"
}Specification: ElicitRequestURLParams
Fields
| Field | Setter | Type | Required |
|---|---|---|---|
message | message/2 | string | yes |
url | url/2 | string | yes |
elicitationId | elicitation_id/2 | string | yes |
_meta | _meta/2 | map | no |
task | task/2 | OzMcp.Structs.TaskMetadata.t/0 | no |
Summary
Types
@type t() :: %OzMcp.Structs.ElicitRequestURLParams{ _meta: map() | nil, elicitationId: String.t(), message: String.t(), task: OzMcp.Structs.TaskMetadata.t() | nil, url: String.t() }