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

ServerSession

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

Constructors

ServerSession

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

Properties

clientCapabilities

var clientCapabilities: ClientCapabilities?

The client's reported capabilities after initialization.

clientVersion

var clientVersion: Implementation?

The client's version information after initialization.

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<RequestId, ProgressCallback>

requestHandlers

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

responseHandlers

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

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: CreateElicitationRequest.RequestedSchema, options: RequestOptions? = null): CreateElicitationResult

createMessage

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

Creates a message using the server's sampling capability.

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)

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(): EmptyRequestResult

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

sendLoggingMessage

suspend fun sendLoggingMessage(notification: LoggingMessageNotification)

Sends a logging message notification to the client.

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?)