Module io.modelcontextprotocol.sdk.mcp
Package io.modelcontextprotocol.spec

Record Class McpSchema.Root

java.lang.Object
java.lang.Record
io.modelcontextprotocol.spec.McpSchema.Root
Record Components:
uri - The URI identifying the root. This *must* start with file:// for now. This restriction may be relaxed in future versions of the protocol to allow other URI schemes.
name - An optional name for the root. This can be used to provide a human-readable identifier for the root, which may be useful for display purposes or for referencing the root in other parts of the application.
meta - See specification for notes on _meta usage
Enclosing class:
McpSchema
public static record McpSchema.Root(String uri, String name, Map<String,Object> meta) extends Record
Represents a root directory or file that the server can operate on.

  • Constructor Details

    • Root

      public Root(String uri, String name)

    • Root

      public Root(String uri, String name, Map<String,Object> meta)
      Creates an instance of a Root record class.
      Parameters:
      uri - the value for the uri record component
      name - the value for the name record component
      meta - the value for the meta record component

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

    • uri

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

    • name

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

    • meta

      public Map<String,Object> meta()
      Returns the value of the meta record component.
      Returns:
      the value of the meta record component