Package io.modelcontextprotocol.spec

Record Class McpSchema.ElicitUrlRequest

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.ElicitUrlRequest

Record Components:

message - The message to present to the user

url - The URL the user must navigate to.

elicitationId - The elicitation ID of the elicitations reques.t

meta - See specification for notes on _meta usage

Note: message, url and elicitationId are required by the MCP specification. Deserialization accepts missing values and substitutes defaults to avoid breaking existing integrations that may omit these fields.

All Implemented Interfaces:

McpSchema.ElicitRequest, McpSchema.Meta, McpSchema.Request

Enclosing class:

McpSchema

public static record McpSchema.ElicitUrlRequest(String message, String url, String elicitationId, Map<String,Object> meta)
extends Record
implements McpSchema.ElicitRequest

A request from the server to elicit additional information from the user out of band, using url mode.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	McpSchema.ElicitUrlRequest.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MODE

Constructor Summary

Constructors

Constructor	Description
ElicitUrlRequest(String message, String url, String elicitationId, Map<String,Object> meta)	Creates an instance of a ElicitUrlRequest record class.

Method Summary

Modifier and Type	Method	Description
static McpSchema.ElicitUrlRequest.Builder	builder(String message, String url, String elicitationId)
String	elicitationId()	Returns the value of the elicitationId record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	message()	Returns the value of the message record component.
Map<String,Object>	meta()	Returns the value of the meta record component.
String	mode()
final String	toString()	Returns a string representation of this record class.
String	url()	Returns the value of the url record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.modelcontextprotocol.spec.McpSchema.Request

progressToken

Field Details

MODE

public static final String MODE

See Also:

• Constant Field Values

Constructor Details

ElicitUrlRequest

public ElicitUrlRequest(String message,
 String url,
 String elicitationId,
 Map<String,Object> meta)

Creates an instance of a ElicitUrlRequest record class.

Parameters:

message - the value for the message record component

url - the value for the url record component

elicitationId - the value for the elicitationId record component

meta - the value for the meta record component

Method Details

mode

public String mode()

Specified by:

mode in interface McpSchema.ElicitRequest

builder

public static McpSchema.ElicitUrlRequest.Builder builder(String message,
 String url,
 String elicitationId)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

message

public String message()

Returns the value of the message record component.

Specified by:

message in interface McpSchema.ElicitRequest

Returns:

the value of the message record component

url

public String url()

Returns the value of the url record component.

Returns:

the value of the url record component

elicitationId

public String elicitationId()

Returns the value of the elicitationId record component.

Returns:

the value of the elicitationId record component

meta

public Map<String,Object> meta()

Returns the value of the meta record component.

Specified by:

meta in interface McpSchema.ElicitRequest

Specified by:

meta in interface McpSchema.Meta

Returns:

the value of the meta record component

See Also:

• Specification for notes on _meta usage