Skip to content

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

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

Merged
merged 5 commits into from
Apr 30, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ed837ba
feat: add message field to ProgressNotification to provide descriptiv…
SeanChinJunKai Apr 9, 2025
6843ee4
Merge branch 'main' into sean/progres-notification
e5l Apr 10, 2025
5301174
Merge branch 'main' into sean/progres-notification
e5l Apr 17, 2025
6ceae04
chore: commit api dump
SeanChinJunKai Apr 30, 2025
bc04351
Merge branch 'main' into sean/progres-notification
e5l Apr 30, 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
16 changes: 10 additions & 6 deletions api/kotlin-sdk.api
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 static final field Companion Lio/modelcontextprotocol/kotlin/sdk/Progress$Companion;
public synthetic fun <init> (IILjava/lang/Double;Lkotlinx/serialization/internal/SerializationConstructorMarker;)V
public fun <init> (ILjava/lang/Double;)V
public synthetic fun <init> (IILjava/lang/Double;Ljava/lang/String;Lkotlinx/serialization/internal/SerializationConstructorMarker;)V
public fun <init> (ILjava/lang/Double;Ljava/lang/String;)V
public fun getMessage ()Ljava/lang/String;
public fun getProgress ()I
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
Expand All @@ -1509,6 +1510,7 @@ public final class io/modelcontextprotocol/kotlin/sdk/Progress$Companion {

public abstract interface class io/modelcontextprotocol/kotlin/sdk/ProgressBase {
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 getTotal ()Ljava/lang/Double;
}
Expand All @@ -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 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 synthetic fun <init> (ILio/modelcontextprotocol/kotlin/sdk/RequestId;Lkotlinx/serialization/json/JsonObject;Ljava/lang/Double;ILkotlin/jvm/internal/DefaultConstructorMarker;)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;Ljava/lang/String;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
public final fun component1 ()I
public final fun component2 ()Lio/modelcontextprotocol/kotlin/sdk/RequestId;
public final fun component3 ()Lkotlinx/serialization/json/JsonObject;
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 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 component5 ()Ljava/lang/String;
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 getMessage ()Ljava/lang/String;
public fun getMethod ()Lio/modelcontextprotocol/kotlin/sdk/Method;
public fun getProgress ()I
public final fun getProgressToken ()Lio/modelcontextprotocol/kotlin/sdk/RequestId;
Expand Down
3 changes: 2 additions & 1 deletion src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/shared/Protocol.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -260,6 +260,7 @@ public abstract class Protocol(
LOGGER.trace { "Received progress notification: token=${notification.progressToken}, progress=${notification.progress}/${notification.total}" }
val progress = notification.progress
val total = notification.total
val message = notification.message
val progressToken = notification.progressToken

val handler = progressHandlers[progressToken]
Expand All @@ -272,7 +273,7 @@ public abstract class Protocol(
return
}

handler.invoke(Progress(progress, total))
handler.invoke(Progress(progress, total, message))
}

private fun onResponse(response: JSONRPCResponse?, error: JSONRPCError?) {
Expand Down
11 changes: 11 additions & 0 deletions 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 @@ -512,6 +512,11 @@ public sealed interface ProgressBase {
* Total number of items to a process (or total progress required), if known.
*/
public val total: Double?

/**
* An optional message describing the current progress.
*/
public val message: String?
}

/* Progress notifications */
Expand All @@ -532,6 +537,11 @@ public open class Progress(
* Total number of items to a process (or total progress required), if known.
*/
override val total: Double?,

/**
* An optional message describing the current progress.
*/
override val message: String?,
) : ProgressBase

/**
Expand All @@ -548,6 +558,7 @@ public data class ProgressNotification(
public val progressToken: ProgressToken,
@Suppress("PropertyName") val _meta: JsonObject = EmptyJsonObject,
override val total: Double?,
override val message: String?,
) : ClientNotification, ServerNotification, ProgressBase {
override val method: Method = Method.Defined.NotificationsProgress
}
Expand Down
Loading