MCP Kotlin SDK/org.jetbrains.kotlinx.mcp.shared/Protocol

Protocol

abstract class Protocol<SendRequestT : Request, SendNotificationT : Notification, SendResultT : RequestResult>(_options: ProtocolOptions?)(source)

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

Inheritors

Client

Server

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

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

notificationHandlers

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

transport

var transport: Transport?

Functions

assertCapabilityForMethod

abstract fun assertCapabilityForMethod(method: Method)

A method to check if a capability is supported by the remote side, for the given method to be called.

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: SendNotificationT)

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: SendRequestT, options: RequestOptions? = null): T

Sends a request and wait 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) -> SendResultT?)

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