kotlin-sdk-server/io.modelcontextprotocol.kotlin.sdk.server/ServerSession

ServerSession

open class ServerSession(serverInfo: Implementation, options: ServerOptions, instructions: String?) : Protocol(source)

Represents an active server-side session in the Model Context Protocol.

Owns the server side of a single client connection on top of Protocol. Drives the initialize/initialized handshake, tracks the negotiated client capabilities and version, asserts capability requirements before dispatching requests and notifications, and exposes server-to-client operations such as sampling, root listing, elicitation, logging, and list-change notifications.

Equality and hashing are based on sessionId, so a session can be used as a key in routing structures.

Parameters

options

server capabilities and protocol options used by Protocol

Constructors

ServerSession

constructor(serverInfo: Implementation, options: ServerOptions, instructions: String?)

Properties

clientCapabilities

val clientCapabilities: ClientCapabilities?

Capabilities reported by the client during initialization, or null before the handshake completes.

clientVersion

val clientVersion: Implementation?

Client implementation information reported during initialization, or null before the handshake completes.

fallbackNotificationHandler

var fallbackNotificationHandler: suspend (notification: JSONRPCNotification) -> Unit?

fallbackRequestHandler

var fallbackRequestHandler: suspend (request: JSONRPCRequest, extra: RequestHandlerExtra) -> RequestResult??

notificationHandlers

val notificationHandlers: Map<String, suspend (notification: JSONRPCNotification) -> Unit>

progressHandlers

val progressHandlers: Map<ProgressToken, ProgressCallback>

requestHandlers

val requestHandlers: Map<String, suspend (request: JSONRPCRequest, extra: RequestHandlerExtra) -> RequestResult?>

responseHandlers

val responseHandlers: Map<RequestId, (response: JSONRPCResponse?, error: Exception?) -> Unit>

sessionId

val sessionId: String

Unique identifier for this session, generated on creation.

transport

var transport: Transport?

Functions

assertRequestHandlerCapability

open override fun assertRequestHandlerCapability(method: Method)

Asserts that the server can handle the specified request method.

suspend fun close()

connect

open suspend fun connect(transport: Transport)

createElicitation

suspend fun createElicitation(message: String, requestedSchema: ElicitRequestParams.RequestedSchema, options: RequestOptions? = null): ElicitResult

Sends a message to the client requesting an elicitation. This typically results in a form being displayed to the end user.

suspend fun createElicitation(message: String, elicitationId: String, url: String, options: RequestOptions? = null): ElicitResult

Sends a URL mode elicitation request to the client, directing the user to an external URL for out-of-band interactions.

createMessage

suspend fun createMessage(params: CreateMessageRequest, options: RequestOptions? = null): CreateMessageResult

Creates a message using the server's sampling capability.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

listRoots

suspend fun listRoots(params: JsonObject = EmptyJsonObject, options: RequestOptions? = null): ListRootsResult

Lists the available "roots" from the client's perspective (if supported).

notification

suspend fun notification(notification: Notification, relatedRequestId: RequestId?)

onClose

open override fun onClose()

Called when the server session is closing.

fun onClose(block: () -> Unit)

Registers a callback to be invoked when the server session is closing.

onError

open fun onError(error: Throwable)

onInitialized

fun onInitialized(block: () -> Unit)

Registers a callback to be invoked when the server has completed initialization.

ping

suspend fun ping(): EmptyResult

Sends a ping request to the client to check connectivity.

removeNotificationHandler

fun removeNotificationHandler(method: Method)

removeRequestHandler

fun removeRequestHandler(method: Method)

request

suspend fun <T : RequestResult> request(request: Request, options: RequestOptions?): T

sendElicitationComplete

suspend fun sendElicitationComplete(notification: ElicitationCompleteNotification)

Sends a notification to the client indicating that an out-of-band elicitation has completed.

sendLoggingMessage

suspend fun sendLoggingMessage(notification: LoggingMessageNotification)

Sends a logging message notification to the client. Messages are filtered based on the current logging level set by the client. If no logging level is set, all messages are sent.

sendPromptListChanged

suspend fun sendPromptListChanged()

Sends a notification to the client indicating that the list of prompts has changed.

sendResourceListChanged

suspend fun sendResourceListChanged()

Sends a notification to the client indicating that the list of resources has changed.

sendResourceUpdated

suspend fun sendResourceUpdated(notification: ResourceUpdatedNotification)

Sends a resource-updated notification to the client, indicating that a specific resource has changed.

sendToolListChanged

suspend fun sendToolListChanged()

Sends a notification to the client indicating that the list of tools has changed.

setNotificationHandler

fun <T : Notification> setNotificationHandler(method: Method, handler: (notification: T) -> Deferred<Unit>)

setRequestHandler

inline fun <T : Request> setRequestHandler(method: Method, noinline block: suspend (T, RequestHandlerExtra) -> RequestResult?)