mcp4k-runtime/sh.ondr.mcp4k.runtime/Server

Server

class Server : McpComponent

A Model Context Protocol (MCP) server implementation that handles MCP requests from a connected client via a specified Transport.

Example usage:

val server = Server.Builder()
    .withPageSize(25)
    .withPrompt(::myPromptFunction)
    .withResourceProvider(myLocalFileProvider)
    .withServerInfo("MyServer", "1.0.0")
    .withTool(::myToolFunction)
    .withTransport(myTransport)
    .withTransportLogger(
      logIncoming = { msg -> println("SERVER INCOMING: $msg") },
      logOutgoing = { msg -> println("SERVER OUTGOING: $msg") },
    )
    .build()

server.start()

Tools and prompts can be added at build time via Builder.withTool, Builder.withTools, Builder.withPrompt, and Builder.withPrompts. They can also be added or removed dynamically at runtime if needed.

Types

Builder for constructing a Server instance.

Functions

fun addPrompt(prompt: KFunction<*>): Boolean

Dynamically adds a new prompt to the server at runtime.

fun addTool(tool: KFunction<*>): Boolean

Dynamically adds a new tool to the server at runtime and sends a ToolListChangedNotification

inline fun <T> getContextAs(): T

handleCallToolRequest

open suspend override fun handleCallToolRequest(params: CallToolRequest.CallToolParams): CallToolResult

handleCompleteRequest

open suspend fun handleCompleteRequest(params: CompleteRequest.CompleteParams): CompleteResult

handleCreateMessageRequest

open suspend fun handleCreateMessageRequest(params: CreateMessageRequest.CreateMessageParams): CreateMessageResult

handleGetPromptRequest

open suspend override fun handleGetPromptRequest(params: GetPromptRequest.GetPromptParams): GetPromptResult

handleInitializeRequest

open suspend override fun handleInitializeRequest(params: InitializeRequest.InitializeParams): InitializeResult

handleListPromptsRequest

open suspend override fun handleListPromptsRequest(params: ListPromptsRequest.ListPromptsParams?): ListPromptsResult

handleListResourcesRequest

open suspend override fun handleListResourcesRequest(params: ListResourcesRequest.ListResourcesParams?): ListResourcesResult

handleListResourceTemplatesRequest

open suspend override fun handleListResourceTemplatesRequest(params: ListResourceTemplatesRequest.ListResourceTemplatesParams?): ListResourceTemplatesResult

handleListRootsRequest

open suspend fun handleListRootsRequest(): ListRootsResult

handleListToolsRequest

open suspend override fun handleListToolsRequest(params: ListToolsRequest.ListToolsParams?): ListToolsResult

handlePingRequest

open suspend fun handlePingRequest(params: PingRequest.PingParams?): EmptyResult

handleReadResourceRequest

open suspend override fun handleReadResourceRequest(params: ReadResourceRequest.ReadResourceParams): ReadResourceResult

handleSetLoggingLevelRequest

open suspend fun handleSetLoggingLevelRequest(params: SetLoggingLevelRequest.SetLoggingLevelParams): EmptyResult

handleSubscribeRequest

open suspend override fun handleSubscribeRequest(params: SubscribeRequest.SubscribeParams): EmptyResult

handleUnsubscribeRequest

open suspend override fun handleUnsubscribeRequest(params: UnsubscribeRequest.UnsubscribeParams): EmptyResult

fun removePrompt(prompt: KFunction<*>): Boolean

Dynamically removes a previously added prompt by its @McpPrompt-annotated function reference.

fun removeTool(tool: KFunction<*>): Boolean

Dynamically removes a previously added tool by its @McpTool-annotated function reference and sends a ToolListChangedNotification

sendNotification

suspend fun sendNotification(notification: JsonRpcNotification)

Sends a notification (fire-and-forget).

suspend fun sendRequest(builder: (id: String) -> JsonRpcRequest): JsonRpcResponse

Sends a request and suspends until a corresponding response is received or this coroutine is cancelled.

suspend fun start()

Starts reading/writing from the given transport.