Package io.modelcontextprotocol.spec

Record Class McpSchema.StringSchema

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.StringSchema
Record Components:
title - Optional title for the text field
description - Optional description for the text field
minLength - Optional minimum string length
maxLength - Optional maximum string length
format - Optional format hint (e.g. "email", "uri")
defaultValue - Optional default value
Enclosing class:
McpSchema
public static record McpSchema.StringSchema(String title, String description, Integer minLength, Integer maxLength, String format, String defaultValue) extends Record
Schema for a text input field in a form-based elicitation request.

  • Constructor Details

    • StringSchema

      public StringSchema(String title, String description, Integer minLength, Integer maxLength, String format, String defaultValue)
      Creates an instance of a StringSchema record class.
      Parameters:
      title - the value for the title record component
      description - the value for the description record component
      minLength - the value for the minLength record component
      maxLength - the value for the maxLength record component
      format - the value for the format record component
      defaultValue - the value for the defaultValue record component

  • Method Details

    • type

      public String type()

    • builder

      public static McpSchema.StringSchema.Builder builder()

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

    • title

      public String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component

    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component

    • minLength

      public Integer minLength()
      Returns the value of the minLength record component.
      Returns:
      the value of the minLength record component

    • maxLength

      public Integer maxLength()
      Returns the value of the maxLength record component.
      Returns:
      the value of the maxLength record component

    • format

      public String format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component

    • defaultValue

      public String defaultValue()
      Returns the value of the defaultValue record component.
      Returns:
      the value of the defaultValue record component