Module io.modelcontextprotocol.sdk.mcp

Package io.modelcontextprotocol.spec

Record Class McpSchema.ClientCapabilities

java.lang.Object

java.lang.Record

io.modelcontextprotocol.spec.McpSchema.ClientCapabilities

Record Components:

experimental - Experimental, non-standard capabilities that the client supports

roots - Present if the client supports listing roots

sampling - Present if the client supports sampling from an LLM

elicitation - Present if the client supports elicitation from the server

Enclosing class:

McpSchema

public static record McpSchema.ClientCapabilities(Map<String,Object> experimental, McpSchema.ClientCapabilities.RootCapabilities roots, McpSchema.ClientCapabilities.Sampling sampling, McpSchema.ClientCapabilities.Elicitation elicitation)
extends Record

Capabilities a client may support. Known capabilities are defined here, in this schema, but this is not a closed set: any client can define its own, additional capabilities.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	McpSchema.ClientCapabilities.Builder
static final record	McpSchema.ClientCapabilities.Elicitation	Provides a standardized way for servers to request additional information from users through the client during interactions.
static final record	McpSchema.ClientCapabilities.RootCapabilities	Present if the client supports listing roots.
static final record	McpSchema.ClientCapabilities.Sampling	Provides a standardized way for servers to request LLM sampling ("completions" or "generations") from language models via clients.

Constructor Summary

Constructors

Constructor	Description
ClientCapabilities(Map<String,Object> experimental, McpSchema.ClientCapabilities.RootCapabilities roots, McpSchema.ClientCapabilities.Sampling sampling, McpSchema.ClientCapabilities.Elicitation elicitation)	Creates an instance of a ClientCapabilities record class.

Method Summary

Modifier and Type	Method	Description
static McpSchema.ClientCapabilities.Builder	builder()
McpSchema.ClientCapabilities.Elicitation	elicitation()	Returns the value of the elicitation record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
Map<String,Object>	experimental()	Returns the value of the experimental record component.
final int	hashCode()	Returns a hash code value for this object.
McpSchema.ClientCapabilities.RootCapabilities	roots()	Returns the value of the roots record component.
McpSchema.ClientCapabilities.Sampling	sampling()	Returns the value of the sampling 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

ClientCapabilities

public ClientCapabilities(Map<String,Object> experimental,
 McpSchema.ClientCapabilities.RootCapabilities roots,
 McpSchema.ClientCapabilities.Sampling sampling,
 McpSchema.ClientCapabilities.Elicitation elicitation)

Creates an instance of a ClientCapabilities record class.

Parameters:

experimental - the value for the experimental record component

roots - the value for the roots record component

sampling - the value for the sampling record component

elicitation - the value for the elicitation record component

Method Details

builder

public static McpSchema.ClientCapabilities.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.

experimental

public Map<String,Object> experimental()

Returns the value of the experimental record component.

Returns:

the value of the experimental record component

roots

public McpSchema.ClientCapabilities.RootCapabilities roots()

Returns the value of the roots record component.

Returns:

the value of the roots record component

sampling

public McpSchema.ClientCapabilities.Sampling sampling()

Returns the value of the sampling record component.

Returns:

the value of the sampling record component

elicitation

public McpSchema.ClientCapabilities.Elicitation elicitation()

Returns the value of the elicitation record component.

Returns:

the value of the elicitation record component