Add request options bag to high level requests and include Meta (#970)

Co-authored-by: Stephen Toub <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 3 people

samples/EverythingServer/Program.cs

@@ -75,7 +75,7 @@ await ctx.Server.SampleAsync([
                 new ChatMessage(ChatRole.System, "You are a helpful test server"),
                 new ChatMessage(ChatRole.User, $"Resource {uri}, context: A new subscription was started"),
             ],
-            options: new ChatOptions
+            chatOptions: new ChatOptions
             {
                 MaxOutputTokens = 100,
                 Temperature = 0.7f,

samples/EverythingServer/Tools/SampleLlmTool.cs

@@ -15,7 +15,7 @@ public static async Task<string> SampleLLM(
         CancellationToken cancellationToken)
     {
         var samplingParams = CreateRequestSamplingParams(prompt ?? string.Empty, "sampleLLM", maxTokens);
-        var sampleResult = await server.SampleAsync(samplingParams, cancellationToken);
+        var sampleResult = await server.SampleAsync(samplingParams, cancellationToken: cancellationToken);
 
         return $"LLM sampling result: {sampleResult.Content.OfType<TextContentBlock>().FirstOrDefault()?.Text}";
     }

samples/TestServerWithHosting/Tools/SampleLlmTool.cs

@@ -18,7 +18,7 @@ public static async Task<string> SampleLLM(
         CancellationToken cancellationToken)
     {
         var samplingParams = CreateRequestSamplingParams(prompt ?? string.Empty, "sampleLLM", maxTokens);
-        var sampleResult = await thisServer.SampleAsync(samplingParams, cancellationToken);
+        var sampleResult = await thisServer.SampleAsync(samplingParams, cancellationToken: cancellationToken);
 
         return $"LLM sampling result: {sampleResult.Content.OfType<TextContentBlock>().FirstOrDefault()?.Text}";
     }

src/ModelContextProtocol.Core/Client/McpClient.Methods.cs

@@ -96,6 +96,6 @@ public async ValueTask<GetPromptResult> GetAsync(
             arguments as IReadOnlyDictionary<string, object?> ??
             arguments?.ToDictionary();
 
-        return await _client.GetPromptAsync(ProtocolPrompt.Name, argDict, serializerOptions, cancellationToken: cancellationToken).ConfigureAwait(false);
+        return await _client.GetPromptAsync(ProtocolPrompt.Name, argDict, new RequestOptions() { JsonSerializerOptions = serializerOptions }, cancellationToken).ConfigureAwait(false);
     }
 }

src/ModelContextProtocol.Core/Client/McpClientPrompt.cs

@@ -78,10 +78,10 @@ public McpClientResource(McpClient client, Resource resource)
     /// <returns>A <see cref="ValueTask{ReadResourceResult}"/> containing the resource's result with content and messages.</returns>
     /// <remarks>
     /// <para>
-    /// This is a convenience method that internally calls <see cref="McpClient.ReadResourceAsync(string, CancellationToken)"/>.
+    /// This is a convenience method that internally calls <see cref="McpClient.ReadResourceAsync(string, RequestOptions, CancellationToken)"/>.
     /// </para>
     /// </remarks>
     public ValueTask<ReadResourceResult> ReadAsync(
         CancellationToken cancellationToken = default) =>
-        _client.ReadResourceAsync(Uri, cancellationToken);
+        _client.ReadResourceAsync(Uri, cancellationToken: cancellationToken);
 }

src/ModelContextProtocol.Core/Client/McpClientResource.cs

@@ -83,5 +83,5 @@ public McpClientResourceTemplate(McpClient client, ResourceTemplate resourceTemp
     public ValueTask<ReadResourceResult> ReadAsync(
         IReadOnlyDictionary<string, object?> arguments,
         CancellationToken cancellationToken = default) =>
-        _client.ReadResourceAsync(UriTemplate, arguments, cancellationToken);
+        _client.ReadResourceAsync(UriTemplate, arguments, cancellationToken: cancellationToken);
 }

src/ModelContextProtocol.Core/Client/McpClientResourceTemplate.cs

@@ -128,7 +128,11 @@ internal McpClientTool(
     protected async override ValueTask<object?> InvokeCoreAsync(
         AIFunctionArguments arguments, CancellationToken cancellationToken)
     {
-        CallToolResult result = await CallAsync(arguments, _progress, JsonSerializerOptions, cancellationToken).ConfigureAwait(false);
+        var options = JsonSerializerOptions is null ? null : new RequestOptions()
+        {
+            JsonSerializerOptions = JsonSerializerOptions,
+        };
+        CallToolResult result = await CallAsync(arguments, _progress, options, cancellationToken).ConfigureAwait(false);
 
         // We want to translate the result content into AIContent, using AIContent as the exchange types, so
         // that downstream IChatClients can specialize handling based on the content (e.g. sending image content
@@ -163,8 +167,8 @@ result.StructuredContent is null &&
     /// value will result in a progress token being included in the call, and any resulting progress notifications during the operation
     /// routed to this instance.
     /// </param>
-    /// <param name="serializerOptions">
-    /// The JSON serialization options governing argument serialization. If <see langword="null"/>, the default serialization options are used.
+    /// <param name="options">
+    /// Optional request options including metadata, serialization settings, and progress tracking.
     /// </param>
     /// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
     /// <returns>
@@ -191,9 +195,16 @@ result.StructuredContent is null &&
     public ValueTask<CallToolResult> CallAsync(
         IReadOnlyDictionary<string, object?>? arguments = null,
         IProgress<ProgressNotificationValue>? progress = null,
-        JsonSerializerOptions? serializerOptions = null,
+        RequestOptions? options = null,
         CancellationToken cancellationToken = default) =>
-        _client.CallToolAsync(ProtocolTool.Name, arguments, progress, serializerOptions, cancellationToken);
+        _client.CallToolAsync(
+            ProtocolTool.Name,
+            arguments,
+            progress,
+            options ?? new RequestOptions() {
+                JsonSerializerOptions = JsonSerializerOptions
+            },
+            cancellationToken);
 
     /// <summary>
     /// Creates a new instance of the tool but modified to return the specified name from its <see cref="Name"/> property.

src/ModelContextProtocol.Core/Client/McpClientTool.cs

@@ -132,6 +132,7 @@ internal static bool IsValidMcpToolSchema(JsonElement element)
     [JsonSerializable(typeof(ListRootsResult))]
     [JsonSerializable(typeof(ListToolsRequestParams))]
     [JsonSerializable(typeof(ListToolsResult))]
+    [JsonSerializable(typeof(PingRequestParams))]
     [JsonSerializable(typeof(PingResult))]
     [JsonSerializable(typeof(ReadResourceRequestParams))]
     [JsonSerializable(typeof(ReadResourceResult))]

src/ModelContextProtocol.Core/McpJsonUtilities.cs

@@ -150,6 +150,7 @@ internal Task SendNotificationAsync<TParameters>(
     /// </summary>
     /// <param name="progressToken">The token that identifies the operation for which progress is being reported.</param>
     /// <param name="progress">The progress update to send, containing information such as percentage complete or status message.</param>
+    /// <param name="options">Optional request options including metadata, serialization settings, and progress tracking.</param>
     /// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
     /// <returns>A task representing the completion of the notification operation (not the operation being tracked).</returns>
     /// <exception cref="ArgumentNullException">The current session instance is <see langword="null"/>.</exception>
@@ -166,6 +167,7 @@ internal Task SendNotificationAsync<TParameters>(
     public Task NotifyProgressAsync(
         ProgressToken progressToken,
         ProgressNotificationValue progress,
+        RequestOptions? options = null,
         CancellationToken cancellationToken = default)
     {
         return SendNotificationAsync(
@@ -174,6 +176,7 @@ public Task NotifyProgressAsync(
             {
                 ProgressToken = progressToken,
                 Progress = progress,
+                Meta = options?.Meta,
             },
             McpJsonUtilities.JsonContext.Default.ProgressNotificationParams,
             cancellationToken);