modelcontextprotocol/kotlin-sdk
Watch
1
0
Fork
You've already forked kotlin-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

docs: add missing KDoc comments for public functions, properties, and classes (#621)

Browse source
This commit is contained in:
Konstantin Pavlov 2026-03-26 18:25:13 +02:00 • committed by GitHub
commit bd4cf0c948
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 21 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
kotlin-sdk-server/src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/server/Server.kt
View file

@ -185,6 +185,7 @@ public open class Server(
block(this)
}
/** Closes this server, shutting down the notification service and all active sessions. */
public suspend fun close() {
logger.debug { "Closing MCP server" }
notificationService.close()
@ -718,6 +719,7 @@ public open class Server(
// Start the ServerSession / ClientConnection redirection section
/** Returns the [ClientConnection] for the session identified by [sessionId]. */
public fun clientConnection(sessionId: String): ClientConnection =
sessionRegistry.getSession(sessionId).clientConnection
@ -827,18 +829,22 @@ public open class Server(
// End the ServerSession / ClientConnection redirection section
// Start the notification handling section
/** Registers a notification [handler] for the given [method] on all active sessions. */
public fun <T : Notification> setNotificationHandler(method: Method, handler: (notification: T) -> Deferred<Unit>) {
sessions.forEach { (_, session) ->
session.setNotificationHandler(method, handler)
}
}
/** Removes the notification handler for the given [method] from all active sessions. */
public fun removeNotificationHandler(method: Method) {
sessions.forEach { (_, session) ->
session.removeNotificationHandler(method)
}
}
/** Registers a notification [handler] for the given [method] on a specific session. */
public fun <T : Notification> setNotificationHandler(
sessionId: String,
method: Method,
@ -847,6 +853,7 @@ public open class Server(
sessionRegistry.getSessionOrNull(sessionId)?.setNotificationHandler(method, handler)
}
/** Removes the notification handler for the given [method] from a specific session. */
public fun removeNotificationHandler(sessionId: String, method: Method) {
sessionRegistry.getSessionOrNull(sessionId)?.removeNotificationHandler(method)
}

2
kotlin-sdk-server/src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/server/StreamableHttpServerTransport.kt
View file

@ -418,6 +418,7 @@ public class StreamableHttpServerTransport(private val configuration: Configurat
}
}
/** Handles an HTTP GET request by establishing a standalone SSE stream for server-initiated notifications. */
@Suppress("ReturnCount")
public suspend fun handleGetRequest(session: ServerSSESession?, call: ApplicationCall) {
// NOTE: enableJsonResponse only controls how POST responses are delivered (JSON vs. SSE).
@ -465,6 +466,7 @@ public class StreamableHttpServerTransport(private val configuration: Configurat
awaitCancellation()
}
/** Handles an HTTP DELETE request by closing the session and the transport. */
public suspend fun handleDeleteRequest(call: ApplicationCall) {
if (!validateSession(call) || !validateProtocolVersion(call)) return
sessionId?.let { onSessionClosed?.invoke(it) }