Skip to content

rename ResourceReference to ResourceTemplateReference #193

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+42 −42
Open

rename ResourceReference to ResourceTemplateReference #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87c79ec
chore: rename ResourceReference to ResourceTemplateReference
zyfy29 Jul 24, 2025
8463e0e
rename resource references in tests and update api
devcrocod Aug 4, 2025
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
58 changes: 29 additions & 29 deletions kotlin-sdk-core/api/kotlin-sdk-core.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2281,35 +2281,6 @@ public final class io/modelcontextprotocol/kotlin/sdk/ResourceListChangedNotific
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public final class io/modelcontextprotocol/kotlin/sdk/ResourceReference : io/modelcontextprotocol/kotlin/sdk/Reference {
public static final field Companion Lio/modelcontextprotocol/kotlin/sdk/ResourceReference$Companion;
public static final field TYPE Ljava/lang/String;
public fun <init> (Ljava/lang/String;)V
public final fun component1 ()Ljava/lang/String;
public final fun copy (Ljava/lang/String;)Lio/modelcontextprotocol/kotlin/sdk/ResourceReference;
public static synthetic fun copy$default (Lio/modelcontextprotocol/kotlin/sdk/ResourceReference;Ljava/lang/String;ILjava/lang/Object;)Lio/modelcontextprotocol/kotlin/sdk/ResourceReference;
public fun equals (Ljava/lang/Object;)Z
public fun getType ()Ljava/lang/String;
public final fun getUri ()Ljava/lang/String;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final synthetic class io/modelcontextprotocol/kotlin/sdk/ResourceReference$$serializer : kotlinx/serialization/internal/GeneratedSerializer {
public static final field INSTANCE Lio/modelcontextprotocol/kotlin/sdk/ResourceReference$$serializer;
public final fun childSerializers ()[Lkotlinx/serialization/KSerializer;
public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Lio/modelcontextprotocol/kotlin/sdk/ResourceReference;
public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object;
public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor;
public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Lio/modelcontextprotocol/kotlin/sdk/ResourceReference;)V
public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V
public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer;
}

public final class io/modelcontextprotocol/kotlin/sdk/ResourceReference$Companion {
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public final class io/modelcontextprotocol/kotlin/sdk/ResourceTemplate {
public static final field Companion Lio/modelcontextprotocol/kotlin/sdk/ResourceTemplate$Companion;
public fun <init> (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V
Expand Down Expand Up @@ -2343,6 +2314,35 @@ public final class io/modelcontextprotocol/kotlin/sdk/ResourceTemplate$Companion
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public final class io/modelcontextprotocol/kotlin/sdk/ResourceTemplateReference : io/modelcontextprotocol/kotlin/sdk/Reference {
public static final field Companion Lio/modelcontextprotocol/kotlin/sdk/ResourceTemplateReference$Companion;
public static final field TYPE Ljava/lang/String;
public fun <init> (Ljava/lang/String;)V
public final fun component1 ()Ljava/lang/String;
public final fun copy (Ljava/lang/String;)Lio/modelcontextprotocol/kotlin/sdk/ResourceTemplateReference;
public static synthetic fun copy$default (Lio/modelcontextprotocol/kotlin/sdk/ResourceTemplateReference;Ljava/lang/String;ILjava/lang/Object;)Lio/modelcontextprotocol/kotlin/sdk/ResourceTemplateReference;
public fun equals (Ljava/lang/Object;)Z
public fun getType ()Ljava/lang/String;
public final fun getUri ()Ljava/lang/String;
public fun hashCode ()I
public fun toString ()Ljava/lang/String;
}

public final synthetic class io/modelcontextprotocol/kotlin/sdk/ResourceTemplateReference$$serializer : kotlinx/serialization/internal/GeneratedSerializer {
public static final field INSTANCE Lio/modelcontextprotocol/kotlin/sdk/ResourceTemplateReference$$serializer;
public final fun childSerializers ()[Lkotlinx/serialization/KSerializer;
public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Lio/modelcontextprotocol/kotlin/sdk/ResourceTemplateReference;
public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object;
public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor;
public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Lio/modelcontextprotocol/kotlin/sdk/ResourceTemplateReference;)V
public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V
public fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer;
}

public final class io/modelcontextprotocol/kotlin/sdk/ResourceTemplateReference$Companion {
public final fun serializer ()Lkotlinx/serialization/KSerializer;
}

public final class io/modelcontextprotocol/kotlin/sdk/ResourceUpdatedNotification : io/modelcontextprotocol/kotlin/sdk/ServerNotification {
public static final field Companion Lio/modelcontextprotocol/kotlin/sdk/ResourceUpdatedNotification$Companion;
public fun <init> (Lio/modelcontextprotocol/kotlin/sdk/ResourceUpdatedNotification$Params;)V
Expand Down
2 changes: 1 addition & 1 deletion kotlin-sdk-core/src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/types.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1502,7 +1502,7 @@ public sealed interface Reference {
* A reference to a resource or resource template definition.
*/
@Serializable
public data class ResourceReference(
public data class ResourceTemplateReference(
/**
* The URI or URI template of the resource.
*/
Expand Down
2 changes: 1 addition & 1 deletion kotlin-sdk-core/src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/types.util.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ internal object StopReasonSerializer : KSerializer<StopReason> {
internal object ReferencePolymorphicSerializer : JsonContentPolymorphicSerializer<Reference>(Reference::class) {
override fun selectDeserializer(element: JsonElement): DeserializationStrategy<Reference> {
return when (element.jsonObject.getValue("type").jsonPrimitive.content) {
ResourceReference.TYPE -> ResourceReference.serializer()
ResourceTemplateReference.TYPE -> ResourceTemplateReference.serializer()
PromptReference.TYPE -> PromptReference.serializer()
else -> UnknownReference.serializer()
}
Expand Down
18 changes: 9 additions & 9 deletions kotlin-sdk-core/src/commonTest/kotlin/io/modelcontextprotocol/kotlin/sdk/TypesTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,21 @@ class TypesTest {

// Reference Tests
@Test
fun `should validate ResourceReference`() {
val resourceRef = ResourceReference(uri = "file:///path/to/file.txt")
fun `should validate ResourceTemplateReference`() {
val resourceRef = ResourceTemplateReference(uri = "file:///path/to/file.txt")

assertEquals("ref/resource", resourceRef.type)
assertEquals("file:///path/to/file.txt", resourceRef.uri)
}

@Test
fun `should serialize and deserialize ResourceReference correctly`() {
val resourceRef = ResourceReference(uri = "https://example.com/resource")
fun `should serialize and deserialize ResourceTemplateReference correctly`() {
val resourceRef = ResourceTemplateReference(uri = "https://example.com/resource")

val json = McpJson.encodeToString<Reference>(resourceRef)
val decoded = McpJson.decodeFromString<Reference>(json)

assertIs<ResourceReference>(decoded)
assertIs<ResourceTemplateReference>(decoded)
assertEquals("ref/resource", decoded.type)
assertEquals("https://example.com/resource", decoded.uri)
}
Expand Down Expand Up @@ -333,12 +333,12 @@ class TypesTest {
@Test
fun `should validate CompleteRequest with resource reference`() {
val request = CompleteRequest(
ref = ResourceReference(uri = "github://repos/{owner}/{repo}"),
ref = ResourceTemplateReference(uri = "github://repos/{owner}/{repo}"),
argument = CompleteRequest.Argument(name = "repo", value = "t")
)

assertEquals("completion/complete", request.method.value)
assertIs<ResourceReference>(request.ref)
assertIs<ResourceTemplateReference>(request.ref)
val resourceRef = request.ref
assertEquals("github://repos/{owner}/{repo}", resourceRef.uri)
assertEquals("repo", request.argument.name)
Expand Down Expand Up @@ -366,11 +366,11 @@ class TypesTest {
@Test
fun `should validate CompleteRequest with complex URIs`() {
val request = CompleteRequest(
ref = ResourceReference(uri = "api://v1/{tenant}/{resource}/{id}"),
ref = ResourceTemplateReference(uri = "api://v1/{tenant}/{resource}/{id}"),
argument = CompleteRequest.Argument(name = "id", value = "123")
)

val resourceRef = request.ref as ResourceReference
val resourceRef = request.ref as ResourceTemplateReference
assertEquals("api://v1/{tenant}/{resource}/{id}", resourceRef.uri)
assertEquals("id", request.argument.name)
assertEquals("123", request.argument.value)
Expand Down
4 changes: 2 additions & 2 deletions kotlin-sdk-core/src/commonTest/kotlin/io/modelcontextprotocol/kotlin/sdk/TypesUtilTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,12 @@ class TypesUtilTest {

// Reference Polymorphic Serializer Tests
@Test
fun `should deserialize ResourceReference polymorphically`() {
fun `should deserialize ResourceTemplateReference polymorphically`() {
val json = """{"type": "ref/resource", "uri": "file:///test.txt"}"""

val decoded = McpJson.decodeFromString<Reference>(json)

assertIs<ResourceReference>(decoded)
assertIs<ResourceTemplateReference>(decoded)
assertEquals("ref/resource", decoded.type)
assertEquals("file:///test.txt", decoded.uri)
}
Expand Down