Skip to content

feat(server): add utility functions for CallToolResult #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 30, 2025
Merged
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
7 changes: 7 additions & 0 deletions api/kotlin-sdk.api
Original file line number Diff line number Diff line change
Expand Up @@ -2492,6 +2492,13 @@ public final class io/modelcontextprotocol/kotlin/sdk/TypesKt {
public static final fun getSUPPORTED_PROTOCOL_VERSIONS ()[Ljava/lang/String;
}

public final class io/modelcontextprotocol/kotlin/sdk/Types_utilKt {
public static final fun error (Lio/modelcontextprotocol/kotlin/sdk/CallToolResult$Companion;Ljava/lang/String;Lkotlinx/serialization/json/JsonObject;)Lio/modelcontextprotocol/kotlin/sdk/CallToolResult;
public static synthetic fun error$default (Lio/modelcontextprotocol/kotlin/sdk/CallToolResult$Companion;Ljava/lang/String;Lkotlinx/serialization/json/JsonObject;ILjava/lang/Object;)Lio/modelcontextprotocol/kotlin/sdk/CallToolResult;
public static final fun ok (Lio/modelcontextprotocol/kotlin/sdk/CallToolResult$Companion;Ljava/lang/String;Lkotlinx/serialization/json/JsonObject;)Lio/modelcontextprotocol/kotlin/sdk/CallToolResult;
public static synthetic fun ok$default (Lio/modelcontextprotocol/kotlin/sdk/CallToolResult$Companion;Ljava/lang/String;Lkotlinx/serialization/json/JsonObject;ILjava/lang/Object;)Lio/modelcontextprotocol/kotlin/sdk/CallToolResult;
}

public final class io/modelcontextprotocol/kotlin/sdk/UnknownContent : io/modelcontextprotocol/kotlin/sdk/PromptMessageContentTextOrImage {
public static final field Companion Lio/modelcontextprotocol/kotlin/sdk/UnknownContent$Companion;
public fun <init> (Ljava/lang/String;)V
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -294,4 +294,24 @@ public class RequestIdSerializer : KSerializer<RequestId> {
is RequestId.NumberId -> jsonEncoder.encodeLong(value.value)
}
}
}
}

/**
* Creates a [CallToolResult] with single [TextContent] and [meta].
*/
public fun CallToolResult.Companion.ok(content: String, meta: JsonObject = EmptyJsonObject): CallToolResult =
CallToolResult(
content = listOf(TextContent(content)),
isError = false,
_meta = meta
)

/**
* Creates a [CallToolResult] with single [TextContent] and [meta], with `isError` being true.
*/
public fun CallToolResult.Companion.error(content: String, meta: JsonObject = EmptyJsonObject): CallToolResult =
CallToolResult(
content = listOf(TextContent(content)),
isError = true,
_meta = meta
)
64 changes: 64 additions & 0 deletions src/commonTest/kotlin/CallToolResultUtilsTest.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
package io.modelcontextprotocol.kotlin.sdk

import kotlinx.serialization.json.JsonPrimitive
import kotlinx.serialization.json.buildJsonObject
import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertFalse
import kotlin.test.assertTrue

class CallToolResultUtilsTest {

@Test
fun testOkWithOnlyText() {
val content = "TextMessage"
val result = CallToolResult.Companion.ok(content)

assertEquals(1, result.content.size)
assertEquals(content, (result.content[0] as TextContent).text)
assertFalse(result.isError == true)
assertEquals(EmptyJsonObject, result._meta)
}

@Test
fun testOkWithMeta() {
val content = "TextMessageWithMeta"
val meta = buildJsonObject {
put("key1", JsonPrimitive("value1"))
put("key2", JsonPrimitive(42))
}
val result = CallToolResult.Companion.ok(content, meta)

assertEquals(1, result.content.size)
assertEquals(content, (result.content[0] as TextContent).text)
assertFalse(result.isError == true)
assertEquals(meta, result._meta)
}

@Test
fun testErrorWithOnlyText() {
val content = "ErrorMessage"
val result = CallToolResult.Companion.error(content)

assertEquals(1, result.content.size)
assertEquals(content, (result.content[0] as TextContent).text)
assertTrue(result.isError == true)
assertEquals(EmptyJsonObject, result._meta)
}

@Test
fun testErrorWithMeta() {
val content = "ErrorMessageWithMeta"
val meta = buildJsonObject {
put("errorCode", JsonPrimitive(404))
put("errorDetail", JsonPrimitive("资源未找到"))
}
val result = CallToolResult.Companion.error(content, meta)

assertEquals(1, result.content.size)
assertEquals(content, (result.content[0] as TextContent).text)
assertTrue(result.isError == true)
assertEquals(meta, result._meta)
}
}

Loading