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

Root

data class Root(val uri: String, val name: String? = null, val meta: JsonObject? = null) : WithMeta(source)

Represents a root directory or file that the server can operate on.

Roots define the top-level locations that a server has access to. They act as boundaries for the server's operations, ensuring it only accesses permitted locations.

Constructors

Root

constructor(uri: String, name: String? = null, meta: JsonObject? = null)

Properties

_meta

open val ~~_meta~~: JsonObject

meta

@SerialName(value = "_meta")

open override val meta: JsonObject?

Optional metadata for this root.

name

val name: String?

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.

uri

val uri: String

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. Examples: "file:///home/user/projects", "file:///workspace/repo", "file:///C:/Documents"