Core Protocol docs edit pass (#1032)

This commit is contained in:
Genevieve Warren 2025-11-25 20:05:25 -08:00 • committed by GitHub
commit c87eba3f1f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -10,8 +10,8 @@ public static class NotificationMethods
/// </summary>
/// <remarks>
/// This notification informs clients that the set of available tools has been modified.
/// Changes may include tools being added, removed, or updated. Upon receiving this
/// notification, clients may refresh their tool list by calling the appropriate
/// Changes may include tools being added, removed, or updated. Upon receiving this
/// notification, clients may refresh their tool list by calling the appropriate
/// method to get the updated list of tools.
/// </remarks>
public const string ToolListChangedNotification = "notifications/tools/list_changed";
@ -21,8 +21,8 @@ public static class NotificationMethods
/// </summary>
/// <remarks>
/// This notification informs clients that the set of available prompts has been modified.
/// Changes may include prompts being added, removed, or updated. Upon receiving this
/// notification, clients may refresh their prompt list by calling the appropriate
/// Changes may include prompts being added, removed, or updated. Upon receiving this
/// notification, clients may refresh their prompt list by calling the appropriate
/// method to get the updated list of prompts.
/// </remarks>
public const string PromptListChangedNotification = "notifications/prompts/list_changed";
@ -32,8 +32,8 @@ public static class NotificationMethods
/// </summary>
/// <remarks>
/// This notification informs clients that the set of available resources has been modified.
/// Changes may include resources being added, removed, or updated. Upon receiving this
/// notification, clients may refresh their resource list by calling the appropriate
/// Changes may include resources being added, removed, or updated. Upon receiving this
/// notification, clients may refresh their resource list by calling the appropriate
/// method to get the updated list of resources.
/// </remarks>
public const string ResourceListChangedNotification = "notifications/resources/list_changed";
@ -52,13 +52,13 @@ public static class NotificationMethods
/// </summary>
/// <remarks>
/// <para>
/// This notification informs the server that the client's "roots" have changed.
/// Roots define the boundaries of where servers can operate within the filesystem,
/// allowing them to understand which directories and files they have access to. Servers
/// This notification informs the server that the client's "roots" have changed.
/// Roots define the boundaries of where servers can operate within the filesystem,
/// allowing them to understand which directories and files they have access to. Servers
/// can request the list of roots from supporting clients and receive notifications when that list changes.
/// </para>
/// <para>
/// After receiving this notification, servers may refresh their knowledge of roots by calling the appropriate
/// After receiving this notification, servers can refresh their knowledge of roots by calling the appropriate
/// method to get the updated list of roots from the client.
/// </para>
/// </remarks>
@ -75,8 +75,8 @@ public static class NotificationMethods
/// </para>
/// <para>
/// The minimum logging level that triggers notifications can be controlled by clients using the
/// <see cref="RequestMethods.LoggingSetLevel"/> request. If no level has been set by a client,
/// the server may determine which messages to send based on its own configuration.
/// <see cref="RequestMethods.LoggingSetLevel"/> request. If no level has been set by a client,
/// the server can determine which messages to send based on its own configuration.
/// </para>
/// </remarks>
public const string LoggingMessageNotification = "notifications/message";
@ -86,8 +86,8 @@ public static class NotificationMethods
/// </summary>
/// <remarks>
/// <para>
/// This notification is sent by the client after it has received and processed the server's response to the
/// <see cref="RequestMethods.Initialize"/> request. It signals that the client is ready to begin normal operation
/// This notification is sent by the client after it has received and processed the server's response to the
/// <see cref="RequestMethods.Initialize"/> request. It signals that the client is ready to begin normal operation
/// and that the initialization phase is complete.
/// </para>
/// <para>
@ -107,7 +107,7 @@ public static class NotificationMethods
/// and optionally, a total value and a descriptive message.
/// </para>
/// <para>
/// Progress notifications may be sent by either the client or the server, depending on the context.
/// Progress notifications can be sent by either the client or the server, depending on the context.
/// Progress notifications enable clients to display progress indicators for operations that might take
/// significant time to complete, such as large file uploads, complex computations, or resource-intensive
/// processing tasks.
@ -116,12 +116,12 @@ public static class NotificationMethods
public const string ProgressNotification = "notifications/progress";
/// <summary>
/// The name of the notification sent to indicate that a previously-issued request should be canceled.
/// The name of the notification sent to indicate that a previously issued request should be canceled.
/// </summary>
/// <remarks>
/// <para>
/// From the issuer's perspective, the request should still be in-flight. However, due to communication latency,
/// it is always possible that this notification may arrive after the request has already finished.
/// it is always possible that this notification might arrive after the request has already finished.
/// </para>
/// <para>
/// This notification indicates that the result will be unused, so any associated processing SHOULD cease.
@ -131,4 +131,4 @@ public static class NotificationMethods
/// </para>
/// </remarks>
public const string CancelledNotification = "notifications/cancelled";
}
}