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

Fix WithMeta + WithProgress causing tool invocation failure (#1464)

Browse source 
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
This commit is contained in:
Copilot 2026-03-27 15:41:58 -04:00 • committed by GitHub
commit 49bf17077d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 97 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/ModelContextProtocol.Core/Client/McpClient.Methods.cs
View file

@ -877,7 +877,7 @@ public abstract partial class McpClient : McpSession
return default; return default;
}).ConfigureAwait(false); }).ConfigureAwait(false);
JsonObject metaWithProgress = meta is not null ? new(meta) : []; JsonObject metaWithProgress = meta is not null ? (JsonObject)meta.DeepClone() : [];
metaWithProgress["progressToken"] = progressToken.ToString(); metaWithProgress["progressToken"] = progressToken.ToString();
return await CallToolAsync( return await CallToolAsync(
@ -1007,7 +1007,7 @@ public abstract partial class McpClient : McpSession
return default; return default;
}).ConfigureAwait(false); }).ConfigureAwait(false);
JsonObject metaWithProgress = meta is not null ? new(meta) : []; JsonObject metaWithProgress = meta is not null ? (JsonObject)meta.DeepClone() : [];
metaWithProgress["progressToken"] = progressToken.ToString(); metaWithProgress["progressToken"] = progressToken.ToString();
var result = await SendRequestAsync( var result = await SendRequestAsync(

95
tests/ModelContextProtocol.Tests/Client/McpClientToolTests.cs
View file

@ -854,4 +854,99 @@ public class McpClientToolTests : ClientServerTestBase
var textBlock = Assert.IsType<TextContentBlock>(result.Content[0]); var textBlock = Assert.IsType<TextContentBlock>(result.Content[0]);
Assert.Contains("coordinates", textBlock.Text); Assert.Contains("coordinates", textBlock.Text);
} }
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task WithProgress_ProgressTokenInMeta(bool useInvokeAsync)
{
await using McpClient client = await CreateMcpClientForServer();
var tools = await client.ListToolsAsync(cancellationToken: TestContext.Current.CancellationToken);
var tool = tools.Single(t => t.Name == "metadata_echo_tool");
var receivedMetadata = await CallMetadataEchoToolWithProgressAsync(tool, useInvokeAsync);
Assert.NotNull(receivedMetadata);
Assert.NotNull(receivedMetadata["progressToken"]?.GetValue<string>());
}
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task WithMeta_WithProgress_BothMetaAndProgressTokenPresent(bool useInvokeAsync)
{
await using McpClient client = await CreateMcpClientForServer();
var tools = await client.ListToolsAsync(cancellationToken: TestContext.Current.CancellationToken);
var tool = tools.Single(t => t.Name == "metadata_echo_tool")
.WithMeta(new() { ["traceId"] = "trace-123" });
var receivedMetadata = await CallMetadataEchoToolWithProgressAsync(tool, useInvokeAsync);
Assert.NotNull(receivedMetadata);
Assert.Equal("trace-123", receivedMetadata["traceId"]?.GetValue<string>());
Assert.NotNull(receivedMetadata["progressToken"]?.GetValue<string>());
}
[Theory]
[InlineData(false)]
[InlineData(true)]
public async Task WithMeta_WithProgress_DoesNotMutateOriginalMeta(bool useInvokeAsync)
{
await using McpClient client = await CreateMcpClientForServer();
var tools = await client.ListToolsAsync(cancellationToken: TestContext.Current.CancellationToken);
var tool = tools.Single(t => t.Name == "metadata_echo_tool");
JsonObject originalMeta = new() { ["traceId"] = "trace-789" };
var toolWithMeta = tool.WithMeta(originalMeta);
await CallMetadataEchoToolWithProgressAsync(toolWithMeta, useInvokeAsync);
await CallMetadataEchoToolWithProgressAsync(toolWithMeta, useInvokeAsync);
Assert.Single(originalMeta);
Assert.Equal("trace-789", originalMeta["traceId"]?.GetValue<string>());
Assert.False(originalMeta.ContainsKey("progressToken"));
}
[Fact]
public async Task WithMeta_WithProgress_WithRequestOptionsMeta_AllMerged()
{
await using McpClient client = await CreateMcpClientForServer();
var tools = await client.ListToolsAsync(cancellationToken: TestContext.Current.CancellationToken);
var tool = tools.Single(t => t.Name == "metadata_echo_tool")
.WithMeta(new() { ["toolKey"] = "toolValue" });
RequestOptions requestOptions = new()
{
Meta = new() { ["requestKey"] = "requestValue" }
};
var receivedMetadata = await CallMetadataEchoToolWithProgressAsync(tool, useInvokeAsync: false, requestOptions);
Assert.NotNull(receivedMetadata);
Assert.Equal("toolValue", receivedMetadata["toolKey"]?.GetValue<string>());
Assert.Equal("requestValue", receivedMetadata["requestKey"]?.GetValue<string>());
Assert.NotNull(receivedMetadata["progressToken"]?.GetValue<string>());
}
private static async Task<JsonObject?> CallMetadataEchoToolWithProgressAsync(
McpClientTool tool, bool useInvokeAsync, RequestOptions? options = null)
{
var progress = new Progress<ProgressNotificationValue>();
string text;
if (useInvokeAsync)
{
tool = tool.WithProgress(progress);
var result = await tool.InvokeAsync(cancellationToken: TestContext.Current.CancellationToken);
text = Assert.IsType<TextContent>(result).Text;
}
else
{
var result = await tool.CallAsync(progress: progress, options: options, cancellationToken: TestContext.Current.CancellationToken);
text = Assert.IsType<TextContentBlock>(result.Content.Single()).Text;
}
return JsonNode.Parse(text)?.AsObject();
}
} }