modelcontextprotocol/kotlin-sdk
Watch
1
0
Fork
You've already forked kotlin-sdk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2

feat: add message field to ProgressNotification according to 2025-03-26 spec (#69)

Browse source 
* feat: add message field to ProgressNotification to provide descriptive status updates

* chore: commit api dump

---------

Co-authored-by: Leonid Stashevsky <e5l@users.noreply.github.com>
This commit is contained in:
SeanChinJunKai 2025-04-30 15:42:19 +08:00 • committed by GitHub
commit b60e12af8f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 23 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

16
api/kotlin-sdk.api
View file

@ -1485,8 +1485,9 @@ public final class io/modelcontextprotocol/kotlin/sdk/PingRequest$Companion {
public class io/modelcontextprotocol/kotlin/sdk/Progress : io/modelcontextprotocol/kotlin/sdk/ProgressBase { public class io/modelcontextprotocol/kotlin/sdk/Progress : io/modelcontextprotocol/kotlin/sdk/ProgressBase {
public static final field Companion Lio/modelcontextprotocol/kotlin/sdk/Progress$Companion; public static final field Companion Lio/modelcontextprotocol/kotlin/sdk/Progress$Companion;
public synthetic fun <init> (IILjava/lang/Double;Lkotlinx/serialization/internal/SerializationConstructorMarker;)V public synthetic fun <init> (IILjava/lang/Double;Ljava/lang/String;Lkotlinx/serialization/internal/SerializationConstructorMarker;)V
public fun <init> (ILjava/lang/Double;)V public fun <init> (ILjava/lang/Double;Ljava/lang/String;)V
public fun getMessage ()Ljava/lang/String;
public fun getProgress ()I public fun getProgress ()I
public fun getTotal ()Ljava/lang/Double; public fun getTotal ()Ljava/lang/Double;
public static final synthetic fun write$Self (Lio/modelcontextprotocol/kotlin/sdk/Progress;Lkotlinx/serialization/encoding/CompositeEncoder;Lkotlinx/serialization/descriptors/SerialDescriptor;)V public static final synthetic fun write$Self (Lio/modelcontextprotocol/kotlin/sdk/Progress;Lkotlinx/serialization/encoding/CompositeEncoder;Lkotlinx/serialization/descriptors/SerialDescriptor;)V
@ -1509,6 +1510,7 @@ public final class io/modelcontextprotocol/kotlin/sdk/Progress$Companion {
public abstract interface class io/modelcontextprotocol/kotlin/sdk/ProgressBase { public abstract interface class io/modelcontextprotocol/kotlin/sdk/ProgressBase {
public static final field Companion Lio/modelcontextprotocol/kotlin/sdk/ProgressBase$Companion; public static final field Companion Lio/modelcontextprotocol/kotlin/sdk/ProgressBase$Companion;
public abstract fun getMessage ()Ljava/lang/String;
public abstract fun getProgress ()I public abstract fun getProgress ()I
public abstract fun getTotal ()Ljava/lang/Double; public abstract fun getTotal ()Ljava/lang/Double;
} }
@ -1519,15 +1521,17 @@ public final class io/modelcontextprotocol/kotlin/sdk/ProgressBase$Companion {
public final class io/modelcontextprotocol/kotlin/sdk/ProgressNotification : io/modelcontextprotocol/kotlin/sdk/ClientNotification, io/modelcontextprotocol/kotlin/sdk/ProgressBase, io/modelcontextprotocol/kotlin/sdk/ServerNotification { public final class io/modelcontextprotocol/kotlin/sdk/ProgressNotification : io/modelcontextprotocol/kotlin/sdk/ClientNotification, io/modelcontextprotocol/kotlin/sdk/ProgressBase, io/modelcontextprotocol/kotlin/sdk/ServerNotification {
public static final field Companion Lio/modelcontextprotocol/kotlin/sdk/ProgressNotification$Companion; public static final field Companion Lio/modelcontextprotocol/kotlin/sdk/ProgressNotification$Companion;
public fun <init> (ILio/modelcontextprotocol/kotlin/sdk/RequestId;Lkotlinx/serialization/json/JsonObject;Ljava/lang/Double;)V public fun <init> (ILio/modelcontextprotocol/kotlin/sdk/RequestId;Lkotlinx/serialization/json/JsonObject;Ljava/lang/Double;Ljava/lang/String;)V
public synthetic fun <init> (ILio/modelcontextprotocol/kotlin/sdk/RequestId;Lkotlinx/serialization/json/JsonObject;Ljava/lang/Double;ILkotlin/jvm/internal/DefaultConstructorMarker;)V public synthetic fun <init> (ILio/modelcontextprotocol/kotlin/sdk/RequestId;Lkotlinx/serialization/json/JsonObject;Ljava/lang/Double;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun component1 ()I public final fun component1 ()I
public final fun component2 ()Lio/modelcontextprotocol/kotlin/sdk/RequestId; public final fun component2 ()Lio/modelcontextprotocol/kotlin/sdk/RequestId;
public final fun component3 ()Lkotlinx/serialization/json/JsonObject; public final fun component3 ()Lkotlinx/serialization/json/JsonObject;
public final fun component4 ()Ljava/lang/Double; public final fun component4 ()Ljava/lang/Double;
public final fun copy (ILio/modelcontextprotocol/kotlin/sdk/RequestId;Lkotlinx/serialization/json/JsonObject;Ljava/lang/Double;)Lio/modelcontextprotocol/kotlin/sdk/ProgressNotification; public final fun component5 ()Ljava/lang/String;
public static synthetic fun copy$default (Lio/modelcontextprotocol/kotlin/sdk/ProgressNotification;ILio/modelcontextprotocol/kotlin/sdk/RequestId;Lkotlinx/serialization/json/JsonObject;Ljava/lang/Double;ILjava/lang/Object;)Lio/modelcontextprotocol/kotlin/sdk/ProgressNotification; public final fun copy (ILio/modelcontextprotocol/kotlin/sdk/RequestId;Lkotlinx/serialization/json/JsonObject;Ljava/lang/Double;Ljava/lang/String;)Lio/modelcontextprotocol/kotlin/sdk/ProgressNotification;
public static synthetic fun copy$default (Lio/modelcontextprotocol/kotlin/sdk/ProgressNotification;ILio/modelcontextprotocol/kotlin/sdk/RequestId;Lkotlinx/serialization/json/JsonObject;Ljava/lang/Double;Ljava/lang/String;ILjava/lang/Object;)Lio/modelcontextprotocol/kotlin/sdk/ProgressNotification;
public fun equals (Ljava/lang/Object;)Z public fun equals (Ljava/lang/Object;)Z
public fun getMessage ()Ljava/lang/String;
public fun getMethod ()Lio/modelcontextprotocol/kotlin/sdk/Method; public fun getMethod ()Lio/modelcontextprotocol/kotlin/sdk/Method;
public fun getProgress ()I public fun getProgress ()I
public final fun getProgressToken ()Lio/modelcontextprotocol/kotlin/sdk/RequestId; public final fun getProgressToken ()Lio/modelcontextprotocol/kotlin/sdk/RequestId;

3
src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/shared/Protocol.kt
View file

@ -260,6 +260,7 @@ public abstract class Protocol(
LOGGER.trace { "Received progress notification: token=${notification.progressToken}, progress=${notification.progress}/${notification.total}" } LOGGER.trace { "Received progress notification: token=${notification.progressToken}, progress=${notification.progress}/${notification.total}" }
val progress = notification.progress val progress = notification.progress
val total = notification.total val total = notification.total
val message = notification.message
val progressToken = notification.progressToken val progressToken = notification.progressToken
val handler = progressHandlers[progressToken] val handler = progressHandlers[progressToken]
@ -272,7 +273,7 @@ public abstract class Protocol(
return return
} }
handler.invoke(Progress(progress, total)) handler.invoke(Progress(progress, total, message))
} }
private fun onResponse(response: JSONRPCResponse?, error: JSONRPCError?) { private fun onResponse(response: JSONRPCResponse?, error: JSONRPCError?) {

11
src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/types.kt
View file

@ -512,6 +512,11 @@ public sealed interface ProgressBase {
* Total number of items to a process (or total progress required), if known. * Total number of items to a process (or total progress required), if known.
*/ */
public val total: Double? public val total: Double?
/**
* An optional message describing the current progress.
*/
public val message: String?
} }
/* Progress notifications */ /* Progress notifications */
@ -532,6 +537,11 @@ public open class Progress(
* Total number of items to a process (or total progress required), if known. * Total number of items to a process (or total progress required), if known.
*/ */
override val total: Double?, override val total: Double?,
/**
* An optional message describing the current progress.
*/
override val message: String?,
) : ProgressBase ) : ProgressBase
/** /**
@ -548,6 +558,7 @@ public data class ProgressNotification(
public val progressToken: ProgressToken, public val progressToken: ProgressToken,
@Suppress("PropertyName") val _meta: JsonObject = EmptyJsonObject, @Suppress("PropertyName") val _meta: JsonObject = EmptyJsonObject,
override val total: Double?, override val total: Double?,
override val message: String?,
) : ClientNotification, ServerNotification, ProgressBase { ) : ClientNotification, ServerNotification, ProgressBase {
override val method: Method = Method.Defined.NotificationsProgress override val method: Method = Method.Defined.NotificationsProgress
} }