Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.ListRootsResult

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.ListRootsResult

Record Components:

roots - An array of Root objects, each representing a root directory or file that the server can operate on.

nextCursor - An optional cursor for pagination. If present, indicates there are more roots available. The client can use this cursor to request the next page of results by sending a roots/list request with the cursor parameter set to this

meta - See specification for notes on _meta usage

All Implemented Interfaces:

McpSchema.Result

Enclosing class:

McpSchema

public static record McpSchema.ListRootsResult(List<McpSchema.Root> roots, String nextCursor, Map<String,Object> meta)
extends Record
implements McpSchema.Result

The client's response to a roots/list request from the server. This result contains an array of Root objects, each representing a root directory or file that the server can operate on.

Constructor Summary

Constructors

Constructor	Description
ListRootsResult(List<McpSchema.Root> roots)
ListRootsResult(List<McpSchema.Root> roots, String nextCursor)
ListRootsResult(List<McpSchema.Root> roots, String nextCursor, Map<String,Object> meta)	Creates an instance of a ListRootsResult record class.

Method Summary

Modifier and Type	Method	Description
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.
Map<String,Object>	meta()	Returns the value of the meta record component.
String	nextCursor()	Returns the value of the nextCursor record component.
List<McpSchema.Root>	roots()	Returns the value of the roots record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

ListRootsResult

public ListRootsResult(List<McpSchema.Root> roots)

ListRootsResult

public ListRootsResult(List<McpSchema.Root> roots,
 String nextCursor)

ListRootsResult

public ListRootsResult(List<McpSchema.Root> roots,
 String nextCursor,
 Map<String,Object> meta)

Creates an instance of a ListRootsResult record class.

Parameters:

roots - the value for the roots record component

nextCursor - the value for the nextCursor 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.

roots

public List<McpSchema.Root> roots()

Returns the value of the roots record component.

Returns:

the value of the roots record component

nextCursor

public String nextCursor()

Returns the value of the nextCursor record component.

Returns:

the value of the nextCursor record component

meta

public Map<String,Object> meta()

Returns the value of the meta record component.

Specified by:

meta in interface McpSchema.Result

Returns:

the value of the meta record component