Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import io.kotest.matchers.shouldBe
import io.kotest.matchers.string.shouldContain
import io.kotest.matchers.string.shouldStartWith
import io.kotest.matchers.types.shouldBeInstanceOf
import io.modelcontextprotocol.kotlin.sdk.ExperimentalMcpApi
import io.modelcontextprotocol.kotlin.sdk.server.Server
import io.modelcontextprotocol.kotlin.sdk.server.ServerOptions
import io.modelcontextprotocol.kotlin.sdk.server.ServerSession
Expand All @@ -29,6 +30,7 @@ import io.modelcontextprotocol.kotlin.sdk.types.ElicitationCompleteNotification
import io.modelcontextprotocol.kotlin.sdk.types.ElicitationCompleteNotificationParams
import io.modelcontextprotocol.kotlin.sdk.types.EmptyJsonObject
import io.modelcontextprotocol.kotlin.sdk.types.EnumOption
import io.modelcontextprotocol.kotlin.sdk.types.HANDSHAKE_PROTOCOL_VERSIONS
import io.modelcontextprotocol.kotlin.sdk.types.Implementation
import io.modelcontextprotocol.kotlin.sdk.types.InitializeResult
import io.modelcontextprotocol.kotlin.sdk.types.IntegerSchema
Expand All @@ -41,11 +43,13 @@ import io.modelcontextprotocol.kotlin.sdk.types.LoggingLevel
import io.modelcontextprotocol.kotlin.sdk.types.LoggingMessageNotification
import io.modelcontextprotocol.kotlin.sdk.types.LoggingMessageNotificationParams
import io.modelcontextprotocol.kotlin.sdk.types.McpException
import io.modelcontextprotocol.kotlin.sdk.types.McpJson
import io.modelcontextprotocol.kotlin.sdk.types.Method
import io.modelcontextprotocol.kotlin.sdk.types.MissingRequiredClientCapabilityData
import io.modelcontextprotocol.kotlin.sdk.types.RPCError
import io.modelcontextprotocol.kotlin.sdk.types.Role
import io.modelcontextprotocol.kotlin.sdk.types.Root
import io.modelcontextprotocol.kotlin.sdk.types.RootsListChangedNotification
import io.modelcontextprotocol.kotlin.sdk.types.SUPPORTED_PROTOCOL_VERSIONS
import io.modelcontextprotocol.kotlin.sdk.types.ServerCapabilities
import io.modelcontextprotocol.kotlin.sdk.types.StringSchema
import io.modelcontextprotocol.kotlin.sdk.types.TextContent
Expand All @@ -59,6 +63,7 @@ import kotlinx.serialization.SerializationException
import kotlinx.serialization.json.JsonPrimitive
import kotlinx.serialization.json.add
import kotlinx.serialization.json.buildJsonObject
import kotlinx.serialization.json.decodeFromJsonElement
import kotlinx.serialization.json.put
import kotlinx.serialization.json.putJsonArray
import kotlin.test.Test
Expand All @@ -69,7 +74,7 @@ class ClientTest {
fun `should initialize with supported older protocol version`() = runTest {
val client = newClient()

client.connect(InitializeTransport { initializeResult(SUPPORTED_PROTOCOL_VERSIONS[1]) })
client.connect(InitializeTransport { initializeResult(HANDSHAKE_PROTOCOL_VERSIONS.first()) })

client.serverVersion shouldBe Implementation(name = "test server", version = "1.0")
}
Expand Down Expand Up @@ -235,9 +240,13 @@ class ClientTest {
fun `should reject server elicitation when elicitation capability is not supported`() = runTest {
val session = connect(newClient())

shouldThrow<IllegalStateException> {
val exception = shouldThrow<McpException> {
session.createElicitation(message = "Provide your name", requestedSchema = nameSchema(required = true))
}.message shouldBe "Client does not support elicitation (required for elicitation/create)"
}

exception.code shouldBe RPCError.ErrorCode.MISSING_REQUIRED_CLIENT_CAPABILITY
exception.missingCapabilities() shouldBe
ClientCapabilities(elicitation = ClientCapabilities.Elicitation(form = EmptyJsonObject))
}

@Test
Expand Down Expand Up @@ -335,9 +344,13 @@ class ClientTest {
fun `should reject URL mode elicitation when client supports only form mode`() = runTest {
val session = connect(newClient(ClientCapabilities(elicitation = ClientCapabilities.Elicitation())))

shouldThrow<IllegalArgumentException> {
val exception = shouldThrow<McpException> {
session.createElicitation(message = "Authorize", elicitationId = "id-1", url = "https://example.com/auth")
}.message shouldBe "Client did not advertise elicitation.url capability; cannot send a URL-mode elicitation."
}

exception.code shouldBe RPCError.ErrorCode.MISSING_REQUIRED_CLIENT_CAPABILITY
exception.missingCapabilities() shouldBe
ClientCapabilities(elicitation = ClientCapabilities.Elicitation(url = EmptyJsonObject))
}

@Test
Expand All @@ -356,10 +369,13 @@ class ClientTest {
fun `should reject elicitation complete when client supports only form mode`() = runTest {
val session = connect(newClient(ClientCapabilities(elicitation = ClientCapabilities.Elicitation())))

shouldThrow<IllegalArgumentException> {
val exception = shouldThrow<McpException> {
session.sendElicitationComplete(elicitationComplete("id-1"))
}.message shouldBe
"Client did not advertise elicitation.url capability; cannot send an elicitation completion notification."
}

exception.code shouldBe RPCError.ErrorCode.MISSING_REQUIRED_CLIENT_CAPABILITY
exception.missingCapabilities() shouldBe
ClientCapabilities(elicitation = ClientCapabilities.Elicitation(url = EmptyJsonObject))
}

@Test
Expand Down Expand Up @@ -444,6 +460,11 @@ class ClientTest {
private fun elicitationComplete(elicitationId: String) =
ElicitationCompleteNotification(ElicitationCompleteNotificationParams(elicitationId = elicitationId))

/** The capabilities a [RPCError.ErrorCode.MISSING_REQUIRED_CLIENT_CAPABILITY] error reports as missing. */
@OptIn(ExperimentalMcpApi::class)
private fun McpException.missingCapabilities(): ClientCapabilities =
McpJson.decodeFromJsonElement<MissingRequiredClientCapabilityData>(checkNotNull(data)).requiredCapabilities

private fun nameSchema(required: Boolean) = ElicitRequestParams.RequestedSchema(
properties = mapOf("name" to StringSchema()),
required = if (required) listOf("name") else null,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
package io.modelcontextprotocol.kotlin.sdk.integration

import io.kotest.matchers.collections.shouldContainExactly
import io.kotest.matchers.shouldBe
import io.modelcontextprotocol.kotlin.sdk.ExperimentalMcpApi
import io.modelcontextprotocol.kotlin.sdk.server.Server
import io.modelcontextprotocol.kotlin.sdk.server.ServerOptions
import io.modelcontextprotocol.kotlin.sdk.testing.ChannelTransport
import io.modelcontextprotocol.kotlin.sdk.types.CallToolResult
import io.modelcontextprotocol.kotlin.sdk.types.EmptyJsonObject
import io.modelcontextprotocol.kotlin.sdk.types.Implementation
import io.modelcontextprotocol.kotlin.sdk.types.JSONRPCMessage
import io.modelcontextprotocol.kotlin.sdk.types.JSONRPCRequest
import io.modelcontextprotocol.kotlin.sdk.types.JSONRPCResponse
import io.modelcontextprotocol.kotlin.sdk.types.LATEST_MODERN_VERSION
import io.modelcontextprotocol.kotlin.sdk.types.LoggingLevel
import io.modelcontextprotocol.kotlin.sdk.types.LoggingMessageNotification
import io.modelcontextprotocol.kotlin.sdk.types.LoggingMessageNotificationParams
import io.modelcontextprotocol.kotlin.sdk.types.McpJson
import io.modelcontextprotocol.kotlin.sdk.types.RequestId
import io.modelcontextprotocol.kotlin.sdk.types.ServerCapabilities
import io.modelcontextprotocol.kotlin.sdk.types.TextContent
import io.modelcontextprotocol.kotlin.sdk.types.ToolSchema
import io.modelcontextprotocol.kotlin.sdk.types.serverInfo
import kotlinx.coroutines.CompletableDeferred
import kotlinx.coroutines.runBlocking
import kotlinx.coroutines.withTimeout
import kotlinx.serialization.json.JsonObject
import kotlinx.serialization.json.JsonPrimitive
import kotlinx.serialization.json.buildJsonObject
import kotlinx.serialization.json.put
import kotlin.test.Test
import kotlin.time.Duration.Companion.seconds

/**
* One connection, both lifecycles, no memory between requests — the property the revision states for
* stdio, where an open process is explicitly not a session and a client may interleave unrelated
* requests freely.
*
* Driven over raw JSON-RPC messages rather than through
* [io.modelcontextprotocol.kotlin.sdk.client.Client] because the typed client settles exactly one
* lifecycle per connection: interleaving is something a conforming client does not do, so no
* client-shaped API can produce it. The property under test is classification, not framing, so an
* in-memory pair stands in for the pipe.
*/
@OptIn(ExperimentalMcpApi::class)
class EraInterleavingTest {

@Test
fun `one connection answers a handshake request and a request-scoped request in turn`() = runBlocking {
val peer = connect()

val handshake = peer.call(id = 1, method = "tools/call", envelope = null)
val scoped = peer.call(id = 2, method = "tools/call", envelope = LATEST_MODERN_VERSION)

// Same connection, same tool, two lifecycles: the identity stamp is the observable
// difference, and each request got the one its own body asked for.
handshake.meta()?.serverInfo shouldBe null
scoped.meta()?.serverInfo shouldBe Implementation("interleaving-server", "1.0")
peer.close()
}

@Test
fun `a request-scoped request does not inherit a log level an earlier request set`() = runBlocking {
val peer = connect()

// The handshake lifecycle's own way of asking for logs, which the revision replaced.
peer.call(
id = 1,
method = "logging/setLevel",
envelope = null,
params = buildJsonObject {
put("level", "debug")
},
)
peer.call(id = 2, method = "tools/call", envelope = LATEST_MODERN_VERSION)

// A level set for one request must not widen what any other request may emit; a
// request-scoped request that did not opt in gets nothing.
peer.notifications shouldContainExactly emptyList()
peer.close()
}

/** A raw peer holding one connection to a server that logs while serving `echo`. */
private class Peer(private val transport: ChannelTransport) {
val notifications: MutableList<String> = mutableListOf()
private val pending = mutableMapOf<RequestId, CompletableDeferred<JSONRPCResponse>>()

suspend fun start() {
transport.onMessage { message ->
when (message) {
is JSONRPCResponse -> pending.remove(message.id)?.complete(message)
else -> notifications += McpJson.encodeToString(message)
}
}
transport.start()
}

suspend fun call(
id: Int,
method: String,
envelope: String?,
params: JsonObject = buildJsonObject { },
): JSONRPCResponse {
val requestId = RequestId.NumberId(id.toLong())
val answer = CompletableDeferred<JSONRPCResponse>()
pending[requestId] = answer
transport.send(request(requestId, method, envelope, params))
return withTimeout(5.seconds) { answer.await() }
}

suspend fun close() = transport.close()

private fun request(
id: RequestId,
method: String,
envelope: String?,
params: JsonObject,
): JSONRPCMessage {
val body = when (method) {
"tools/call" -> buildJsonObject {
put("name", "echo")
put("arguments", EmptyJsonObject)
}

else -> params
}
val withMeta = if (envelope == null) {
body
} else {
JsonObject(
body + (
"_meta" to buildJsonObject {
put("io.modelcontextprotocol/protocolVersion", envelope)
put("io.modelcontextprotocol/clientCapabilities", EmptyJsonObject)
}
),
)
}
return JSONRPCRequest(id = id, method = method, params = withMeta)
}
}

private suspend fun connect(): Peer {
val server = Server(
serverInfo = Implementation("interleaving-server", "1.0"),
options = ServerOptions(
capabilities = ServerCapabilities(
tools = ServerCapabilities.Tools(null),
logging = EmptyJsonObject,
),
),
)
server.addTool(
name = "echo",
description = "echoes, noisily",
inputSchema = ToolSchema(properties = EmptyJsonObject, required = null),
) {
sendLoggingMessage(
LoggingMessageNotification(
LoggingMessageNotificationParams(
level = LoggingLevel.Debug,
data = JsonPrimitive("serving echo"),
),
),
)
CallToolResult(content = listOf(TextContent("echoed")))
}

val (clientTransport, serverTransport) = ChannelTransport.createLinkedPair()
server.createSession(serverTransport)
return Peer(clientTransport).also { it.start() }
}

private fun JSONRPCResponse.meta() = result.meta
}
Loading
Loading