kotlin-sdk-client/io.modelcontextprotocol.kotlin.sdk.client

Package-level declarations

Types

open class Client(clientInfo: Implementation, options: ClientOptions = ClientOptions()) : Protocol

An MCP client on top of a pluggable transport.

class ClientOptions(val capabilities: ClientCapabilities = ClientCapabilities(), enforceStrictCapabilities: Boolean = true) : ProtocolOptions

Options for configuring the MCP client.

SSEClientTransport

typealias ~~SSEClientTransport~~ = SseClientTransport

SseClientTransport

class SseClientTransport(client: HttpClient, urlString: String?, reconnectionTime: Duration? = null, requestBuilder: HttpRequestBuilder.() -> Unit = {}) : AbstractTransport

Client transport for SSE: this will connect to a server using Server-Sent Events for receiving messages and make separate POST requests for sending messages.

StdioClientTransport

class StdioClientTransport @JvmOverloads constructor(input: Source, output: Sink, error: Source? = null, sendChannel: Channel<JSONRPCMessage> = Channel(Channel.BUFFERED), classifyStderr: (String) -> StdioClientTransport.StderrSeverity = { DEBUG }) : AbstractTransport

A transport implementation for JSON-RPC communication over standard I/O streams.

StreamableHttpClientTransport

class StreamableHttpClientTransport(client: HttpClient, url: String, reconnectionTime: Duration? = null, requestBuilder: HttpRequestBuilder.() -> Unit = {}) : AbstractTransport

Client transport for Streamable HTTP: this implements the MCP Streamable HTTP transport specification. It will connect to a server using HTTP POST for sending messages and HTTP GET with Server-Sent Events for receiving messages.

StreamableHttpError

class StreamableHttpError(val code: Int? = null, message: String? = null) : Exception

Error class for Streamable HTTP transport errors.

WebSocketClientTransport

class WebSocketClientTransport(client: HttpClient, urlString: String?, requestBuilder: HttpRequestBuilder.() -> Unit = {}) : WebSocketMcpTransport

Client transport for WebSocket: this will connect to a server over the WebSocket protocol.

Functions

mcpClient

@ExperimentalMcpApi

suspend fun mcpClient(clientInfo: Implementation, clientOptions: ClientOptions = ClientOptions(), transport: Transport): Client

Initializes and connects an MCP client using the provided clientInfo Implementation, client options, and transport mechanism.

mcpSse

suspend fun HttpClient.mcpSse(urlString: String? = null, reconnectionTime: Duration? = null, requestBuilder: HttpRequestBuilder.() -> Unit = {}): Client

Creates and connects an MCP client over SSE using the provided HttpClient.

mcpSseTransport

fun HttpClient.mcpSseTransport(urlString: String? = null, reconnectionTime: Duration? = null, requestBuilder: HttpRequestBuilder.() -> Unit = {}): SseClientTransport

Returns a new SSE transport for the Model Context Protocol using the provided HttpClient.

mcpStreamableHttp

suspend fun HttpClient.mcpStreamableHttp(url: String, reconnectionTime: Duration? = null, requestBuilder: HttpRequestBuilder.() -> Unit = {}): Client

Creates and connects an MCP client over Streamable HTTP using the provided HttpClient.

mcpStreamableHttpTransport

fun HttpClient.mcpStreamableHttpTransport(url: String, reconnectionTime: Duration? = null, requestBuilder: HttpRequestBuilder.() -> Unit = {}): StreamableHttpClientTransport

Returns a new Streamable HTTP transport for the Model Context Protocol using the provided HttpClient.

mcpWebSocket

suspend fun HttpClient.mcpWebSocket(urlString: String? = null, requestBuilder: HttpRequestBuilder.() -> Unit = {}): Client

Creates and connects an MCP client over WebSocket using the provided HttpClient.

mcpWebSocketTransport

fun HttpClient.mcpWebSocketTransport(urlString: String? = null, requestBuilder: HttpRequestBuilder.() -> Unit = {}): WebSocketClientTransport

Returns a new WebSocket transport for the Model Context Protocol using the provided HttpClient.