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

Package-level declarations

Types

data class RegisteredPrompt(val prompt: Prompt, val messageProvider: suspend (GetPromptRequest) -> GetPromptResult)

A wrapper class representing a registered prompt on the server.

data class RegisteredResource(val resource: Resource, val readHandler: suspend (ReadResourceRequest) -> ReadResourceResult)

A wrapper class representing a registered resource on the server.

RegisteredTool

data class RegisteredTool(val tool: Tool, val handler: suspend (CallToolRequest) -> CallToolResult)

A wrapper class representing a registered tool on the server.

Server

open class Server(serverInfo: Implementation, options: ServerOptions, instructionsProvider: () -> String? = null)

An MCP server on top of a pluggable transport.

ServerOptions

class ServerOptions(val capabilities: ServerCapabilities, enforceStrictCapabilities: Boolean = true) : ProtocolOptions

Configuration options for the MCP server.

ServerSession

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

SSEServerTransport

typealias ~~SSEServerTransport~~ = SseServerTransport

SseServerTransport

class SseServerTransport(endpoint: String, session: ServerSSESession) : AbstractTransport

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

StdioServerTransport

class StdioServerTransport(inputStream: Source, outputStream: Sink) : AbstractTransport

A server transport that communicates with a client via standard I/O.

WebSocketMcpServerTransport

class WebSocketMcpServerTransport(session: WebSocketServerSession) : WebSocketMcpTransport

Server-side implementation of the MCP (Model Context Protocol) transport over WebSocket.

Functions

MCP

fun Application.~~MCP~~(block: ServerSSESession.() -> Server)

mcp

fun Application.mcp(block: ServerSSESession.() -> Server)

fun Routing.mcp(block: ServerSSESession.() -> Server)

fun Routing.mcp(path: String, block: ServerSSESession.() -> Server)

mcpWebSocket

fun Application.mcpWebSocket(block: () -> Server)

fun Routing.mcpWebSocket(block: () -> Server)

fun Routing.mcpWebSocket(path: String, block: () -> Server)

Configures the Ktor Application to handle Model Context Protocol (MCP) over WebSocket.

fun Route.~~mcpWebSocket~~(block: () -> Server)

fun Application.mcpWebSocket(path: String, block: () -> Server)

Configures the Ktor Application to handle Model Context Protocol (MCP) over WebSocket at the specified path.

fun Route.~~mcpWebSocket~~(options: ServerOptions? = null, handler: suspend Server.() -> Unit = {})

Registers a WebSocket route that establishes an MCP (Model Context Protocol) server session.

fun Route.~~mcpWebSocket~~(path: String, options: ServerOptions? = null, handler: suspend Server.() -> Unit = {})

Registers a WebSocket route at the specified path that establishes an MCP server session.

mcpWebSocketTransport

fun Route.~~mcpWebSocketTransport~~(handler: suspend WebSocketMcpServerTransport.() -> Unit = {})

Registers a WebSocket route that creates an MCP server transport layer.

fun Route.~~mcpWebSocketTransport~~(path: String, handler: suspend WebSocketMcpServerTransport.() -> Unit = {})

Registers a WebSocket route at the specified path that creates an MCP server transport layer.