Fix providing progressToken with request #405
Open
+232
−16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a bug where progress tokens were not being properly attached to request parameters when a progress handler is provided. The fix ensures that when onProgress is specified in RequestOptions, the request's _meta field is correctly updated with the progressToken.
Key Changes:
- Modified request handling to inject
progressTokeninto request metadata when progress handling is enabled - Added comprehensive test coverage for progress token scenarios
- Improved variable naming and error handling in the Protocol class
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| kotlin-sdk-core/src/commonMain/kotlin/io/modelcontextprotocol/kotlin/sdk/shared/Protocol.kt | Core fix: adds logic to inject progressToken into request params when onProgress is provided; improves variable naming (messageId → jsonRpcRequestId) and error handling (Error → IllegalStateException) |
| kotlin-sdk-core/src/commonTest/kotlin/io/modelcontextprotocol/kotlin/sdk/shared/ProtocolTest.kt | Adds comprehensive test coverage for progress token handling including cases for preserving existing meta, creating meta when absent, and handling null params |
| kotlin-sdk-core/build.gradle.kts | Adds kotlinx-coroutines-test dependency required for the new test infrastructure |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
kpavlov
approved these changes
Nov 18, 2025
Contributor
kpavlov
left a comment
kpavlov
left a comment
There was a problem hiding this comment.
Thank you for the fix.
I have a couple of comments, but it can be addressed later
| override fun assertRequestHandlerCapability(method: Method) {} | ||
| } | ||
|
|
||
| private class RecordingTransport : Transport { |
Contributor
There was a problem hiding this comment.
good stuff, let's extract it
| private var onMessageCallback: (suspend (JSONRPCMessage) -> Unit)? = null | ||
| private var onCloseCallback: (() -> Unit)? = null | ||
|
|
||
| override suspend fun start() {} |
Contributor
There was a problem hiding this comment.
it make sense to add debug logging here
| } | ||
| } | ||
|
|
||
| private class TestProtocol : Protocol(null) { |
Contributor
There was a problem hiding this comment.
good stuff, let's extract it
Comment on lines
+58
to
+65
| val sent = transport.awaitRequest() | ||
| val params = requireNotNull(sent.params).jsonObject | ||
| val meta = params["_meta"]!!.jsonObject | ||
|
|
||
| assertEquals("test://resource", params["uri"]!!.jsonPrimitive.content) | ||
| assertEquals("customValue", meta["customField"]!!.jsonPrimitive.content) | ||
| assertEquals(123, meta["anotherField"]!!.jsonPrimitive.int) | ||
| assertEquals(McpJson.encodeToJsonElement(sent.id), meta["progressToken"]) |
Contributor
There was a problem hiding this comment.
with kotest it might be a bit more readable:
Suggested change
| val sent = transport.awaitRequest() | |
| val params = requireNotNull(sent.params).jsonObject | |
| val meta = params["_meta"]!!.jsonObject | |
| assertEquals("test://resource", params["uri"]!!.jsonPrimitive.content) | |
| assertEquals("customValue", meta["customField"]!!.jsonPrimitive.content) | |
| assertEquals(123, meta["anotherField"]!!.jsonPrimitive.int) | |
| assertEquals(McpJson.encodeToJsonElement(sent.id), meta["progressToken"]) | |
| val sent = transport.awaitRequest() | |
| val params = sent.params?.jsonObject.shouldNotBeNull() | |
| params["uri"] shouldBe JsonPrimitive("test://resource") | |
| val meta = params["_meta"]?.jsonObject.shouldNotBeNull() | |
| meta["customField"] shouldBe JsonPrimitive("customValue") | |
| meta["anotherField"] shouldBe JsonPrimitive(123) | |
| meta["progressToken"] shouldBe McpJson.encodeToJsonElement(sent.id) |
9 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
fix #220
How Has This Been Tested?
locally
Breaking Changes
None
Types of changes
Checklist