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,9 +1,19 @@
namespace ModelContextProtocol.Protocol.Types;
using ModelContextProtocol.Protocol.Messages;
namespace ModelContextProtocol.Protocol.Types;
/// <summary>
/// Dummy result for the ping request.
/// <see href="https://github.com/modelcontextprotocol/specification/blob/main/schema/">See the schema for details</see>
/// Represents the result of a <see cref="RequestMethods.Ping"/> request in the Model Context Protocol.
/// </summary>
public record PingResult
{
}
/// <remarks>
/// <para>
/// The <see cref="PingResult"/> is returned in response to a <see cref="RequestMethods.Ping"/> request,
/// which is used to verify that the connection between client and server is still alive and responsive.
/// Since this is a simple connectivity check, the result is an empty object containing no data.
/// </para>
/// <para>
/// Ping requests can be initiated by either the client or the server to check if the other party
/// is still responsive.
/// </para>
/// </remarks>
public record PingResult;