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

SseServerTransport

class SseServerTransport(endpoint: String, session: ServerSSESession, maxRequestBodySize: Long = DEFAULT_MAX_REQUEST_BODY_SIZE) : AbstractTransport(source)

Server transport for SSE: this will send messages over an SSE connection and receive messages from HTTP POST requests.

Creates a new SSE server transport, which will direct the client to POST messages to the relative or absolute URL identified by _endpoint.

Parameters

endpoint

relative or absolute URL the client will POST messages to

session

active SSE session used to deliver server-to-client events

maxRequestBodySize

maximum allowed size, in bytes, of an incoming POST body; larger requests are rejected with 413 Payload Too Large without being buffered in full. Defaults to 4 MiB.

Constructors

SseServerTransport

constructor(endpoint: String, session: ServerSSESession, maxRequestBodySize: Long = DEFAULT_MAX_REQUEST_BODY_SIZE)

Properties

sessionId

val sessionId: String

Unique identifier for this transport session, generated randomly on creation.

Functions

open suspend override fun close()

handleMessage

suspend fun handleMessage(message: String)

Handle a client message, regardless of how it arrived. This can be used to inform the server of messages that arrive via a means different from HTTP POST.

handlePostMessage

suspend fun handlePostMessage(call: ApplicationCall)

Handles incoming POST messages.

onClose

open override fun onClose(block: () -> Unit)

onError

open override fun onError(block: (Throwable) -> Unit)

onMessage

open override fun onMessage(block: suspend (JSONRPCMessage) -> Unit)

send

open suspend override fun send(message: JSONRPCMessage, options: TransportSendOptions?)

start

open suspend override fun start()

Handles the initial SSE connection request.