Package io.modelcontextprotocol.spec

Record Class McpSchema.ClientCapabilities.Elicitation

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.ClientCapabilities.Elicitation
Record Components:
form - support for in-band form-based elicitation
url - support for out-of-band URL-based elicitation
Enclosing class:
McpSchema.ClientCapabilities
public static record McpSchema.ClientCapabilities.Elicitation(McpSchema.ClientCapabilities.Elicitation.Form form, McpSchema.ClientCapabilities.Elicitation.Url url) extends Record
Provides a standardized way for servers to request additional information from users through the client during interactions. This flow allows clients to maintain control over user interactions and data sharing while enabling servers to gather necessary information dynamically. Servers can request structured data from users with optional JSON schemas to validate responses.

Per the 2025-11-25 spec, clients can declare support for specific elicitation modes:

  • form - In-band structured data collection with optional schema validation
  • url - Out-of-band interaction via URL navigation

For backward compatibility, an empty elicitation object {} is equivalent to declaring support for form mode only.

  • Constructor Details

  • Method Details

    • 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.

    • form

      public McpSchema.ClientCapabilities.Elicitation.Form form()
      Returns the value of the form record component.
      Returns:
      the value of the form record component

    • url

      public McpSchema.ClientCapabilities.Elicitation.Url url()
      Returns the value of the url record component.
      Returns:
      the value of the url record component