kotlin-sdk-core/io.modelcontextprotocol.kotlin.sdk.shared/Protocol

Protocol

abstract class Protocol(options: ProtocolOptions?)(source)

Implements MCP protocol framing on top of a pluggable transport, including features like request/response linking, notifications, and progress.

Constructors

Protocol

constructor(options: ProtocolOptions?)

Properties

fallbackNotificationHandler

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

A handler to invoke for any notification types that do not have their own handler installed.

fallbackRequestHandler

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

A handler to invoke for any request types that do not have their own handler installed.

notificationHandlers

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

registered notification handlers keyed by method name

progressHandlers

val progressHandlers: Map<ProgressToken, ProgressCallback>

registered progress callbacks keyed by progress token

requestHandlers

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

registered request handlers keyed by method name

responseHandlers

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

pending response handlers keyed by request ID

transport

var transport: Transport?

the active transport, or null if not connected

Functions

assertRequestHandlerCapability

abstract fun assertRequestHandlerCapability(method: Method)

A method to check if a request handler is supported by the local side, for the given method to be handled.

suspend fun close()

Closes the connection.

connect

open suspend fun connect(transport: Transport)

Attaches to the given transport, starts it, and starts listening for messages.

notification

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

Emits a notification, which is a one-way message that does not expect a response.

onClose

open fun onClose()

Callback for when the connection is closed for any reason.

onError

open fun onError(error: Throwable)

Callback for when an error occurs.

removeNotificationHandler

fun removeNotificationHandler(method: Method)

Removes the notification handler for the given method.

removeRequestHandler

fun removeRequestHandler(method: Method)

Removes the request handler for the given method.

request

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

Sends a request and waits for a response.

setNotificationHandler

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

Registers a handler to invoke when this protocol object receives a notification with the given method.

setRequestHandler

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

Registers a handler to invoke when this protocol object receives a request with the given method.