AI seeded comments from robch and then edited by stephentoub (#238)

* AI generated `///` comment updates

* Fix compilation issues

* Fix incorrect XML comment structure

* Update all Client comments

* Update all Configuration comments

* Update all Messages comments

* Update all Transport comments

* Update all Types comments

* Update all Server comments

* Undo some commenting

---------

Co-authored-by: Stephen Toub <stoub@microsoft.com>
This commit is contained in:
Rob Chambers 2025-04-09 22:30:44 -07:00 • committed by GitHub
commit 77871c5aac
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,4 +1,4 @@
using ModelContextProtocol.Protocol.Messages;
using ModelContextProtocol.Protocol.Messages;
using ModelContextProtocol.Utils;
using System.Text.Json;
using System.Text.Json.Nodes;
@ -9,14 +9,25 @@ namespace ModelContextProtocol.Shared;
internal sealed class RequestHandlers : Dictionary<string, Func<JsonRpcRequest, CancellationToken, Task<JsonNode?>>>
{
/// <summary>
/// Registers a handler for incoming requests of a specific method.
/// Registers a handler for incoming requests of a specific method in the MCP protocol.
/// </summary>
/// <typeparam name="TRequest">Type of request payload</typeparam>
/// <typeparam name="TResponse">Type of response payload (not full RPC response</typeparam>
/// <param name="method">Method identifier to register for</param>
/// <param name="handler">Handler to be called when a request with specified method identifier is received</param>
/// <param name="requestTypeInfo">The JSON contract governing request serialization.</param>
/// <param name="responseTypeInfo">The JSON contract governing response serialization.</param>
/// <typeparam name="TRequest">Type of request payload that will be deserialized from incoming JSON</typeparam>
/// <typeparam name="TResponse">Type of response payload that will be serialized to JSON (not full RPC response)</typeparam>
/// <param name="method">Method identifier to register for (e.g., "tools/list", "logging/setLevel")</param>
/// <param name="handler">Handler function to be called when a request with the specified method identifier is received</param>
/// <param name="requestTypeInfo">The JSON contract governing request parameter deserialization</param>
/// <param name="responseTypeInfo">The JSON contract governing response serialization</param>
/// <remarks>
/// <para>
/// This method is used internally by the MCP infrastructure to register handlers for various protocol methods.
/// When an incoming request matches the specified method, the registered handler will be invoked with the
/// deserialized request parameters.
/// </para>
/// <para>
/// The handler function receives the deserialized request object and a cancellation token, and should return
/// a response object that will be serialized back to the client.
/// </para>
/// </remarks>
public void Set<TRequest, TResponse>(
string method,
Func<TRequest?, CancellationToken, Task<TResponse>> handler,