Skip to content

Fix RequestOptions writing an integer progress token as a JSON string #1832

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
dfedoryshchev wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −1
Open

Fix RequestOptions writing an integer progress token as a JSON string #1832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 1 deletion src/ModelContextProtocol.Core/RequestOptions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,12 @@ internal RequestOptions Clone() =>
if (ProgressToken is not null)
{
meta = (JsonObject?)meta?.DeepClone() ?? [];
meta["progressToken"] = ProgressToken.ToString();

// Serialize through ProgressToken's own converter rather than ToString(), so that an integer
// token is written as a JSON number. Stringifying it changes the token the peer echoes back
// in progress notifications, and the caller then no longer recognizes its own token.
meta["progressToken"] = JsonSerializer.SerializeToNode(
ProgressToken.Value, McpJsonUtilities.JsonContext.Default.ProgressToken);
}

return meta;
Expand Down
15 changes: 15 additions & 0 deletions tests/ModelContextProtocol.Tests/RequestOptionsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,21 @@ public static void GetMetaForRequest_OnlyProgressTokenSetAsLong_ReturnsNewObject
Assert.NotSame(actual, options.GetMetaForRequest());
}

[Fact]
public static void GetMetaForRequest_LongProgressToken_IsWrittenAsJsonNumber()
{
RequestOptions options = new() { ProgressToken = new ProgressToken(42L) };

var actual = options.GetMetaForRequest();

Assert.NotNull(actual);
Assert.Equal(JsonValueKind.Number, actual["progressToken"]!.GetValueKind());

// The token the peer reads back must be the token the caller asked for.
RequestParams request = new CallToolRequestParams { Name = "tool", Meta = actual };
Assert.Equal(new ProgressToken(42L), request.ProgressToken);
}

[Fact]
public static void GetMetaForRequest_BothSet_ReturnsCloneWithProgressToken()
{
Expand Down