kotlin-sdk-core/io.modelcontextprotocol.kotlin.sdk.types/ClientCapabilities

ClientCapabilities

data class ClientCapabilities(val sampling: ClientCapabilities.Sampling? = null, val roots: ClientCapabilities.Roots? = null, val elicitation: JsonObject? = null, val experimental: JsonObject? = null, val extensions: Map<String, JsonObject>? = null)(source)

Capabilities that a client may support.

Known capabilities are defined here, but this is not a closed set: any client can define its own additional capabilities through the experimental field.

The presence of a capability object (non-null value) indicates that the client supports that capability.

Constructors

ClientCapabilities

constructor(sampling: ClientCapabilities.Sampling? = null, roots: ClientCapabilities.Roots? = null, elicitation: JsonObject? = null, experimental: JsonObject? = null, extensions: Map<String, JsonObject>? = null)

constructor(sampling: JsonObject?, roots: ClientCapabilities.Roots? = null, elicitation: JsonObject? = null, experimental: JsonObject? = null, extensions: Map<String, JsonObject>? = null)

Source-compatibility constructor retaining the pre-SEP-1577 sampling: JsonObject? shape. Any non-null sampling is converted to an empty Sampling (sub-capabilities cannot be recovered from the old opaque JsonObject).

Types

Companion

object Companion

Roots

@Serializable

data class Roots(val listChanged: Boolean? = null)

Indicates that the client supports listing roots.

Sampling

@Serializable

data class Sampling(val context: JsonObject? = null, val tools: JsonObject? = null)

sub-capabilities for sampling.

Properties

elicitation

val elicitation: JsonObject?

Present if the client supports elicitation from the server.

experimental

val experimental: JsonObject?

Experimental, non-standard capabilities that the client supports. Keys are capability names, values are capability-specific configuration objects.

extensions

val extensions: Map<String, JsonObject>?

Optional extensions that the client supports. Keys are extension identifiers (e.g., "io.modelcontextprotocol/ui"), values are extension-specific settings objects.

roots

val roots: ClientCapabilities.Roots?

Present if the client supports listing roots.

sampling

val sampling: ClientCapabilities.Sampling?

Present if the client supports sampling from an LLM. Use ClientCapabilities.Sampling to configure SEP-1577 sub-capabilities (tools, context).