Skip to content

Clarify null semantics in ToolAnnotations hint property docs #1346

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeffhandley merged 2 commits into from
Feb 23, 2026
+11 −11
Merged

Clarify null semantics in ToolAnnotations hint property docs #1346

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc75b64
Initial plan
Copilot Feb 21, 2026
ea43a0a
Clarify ToolAnnotations null semantics in XML documentation
Copilot Feb 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions src/ModelContextProtocol.Core/Protocol/ToolAnnotations.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ public sealed class ToolAnnotations
/// Gets or sets a value that indicates whether the tool can perform destructive updates to its environment.
/// </summary>
/// <value>
/// The default is <see langword="true"/>.
/// <see langword="true"/> if the tool can perform destructive updates to its environment;
/// <see langword="false"/> if the tool performs only additive updates;
/// <see langword="null"/> if unspecified, in which case clients should assume <see langword="true"/>.
/// </value>
/// <remarks>
/// If <see langword="true"/>, the tool can perform destructive updates to its environment.
/// If <see langword="false"/>, the tool performs only additive updates.
/// This property is most relevant when the tool modifies its environment (ReadOnly = false).
/// </remarks>
[JsonPropertyName("destructiveHint")]
Expand All @@ -49,8 +49,8 @@ public sealed class ToolAnnotations
/// </summary>
/// <value>
/// <see langword="true"/> if calling the tool repeatedly with the same arguments
/// has no additional effect on the environment; <see langword="false"/> if it does.
/// The default is <see langword="false"/>.
/// has no additional effect on the environment; <see langword="false"/> if it does;
/// <see langword="null"/> if unspecified, in which case clients should assume <see langword="false"/>.
/// </value>
/// <remarks>
/// This property is most relevant when the tool modifies its environment (ReadOnly = false).
Expand All @@ -62,9 +62,9 @@ public sealed class ToolAnnotations
/// Gets or sets a value that indicates whether this tool can interact with an "open world" of external entities.
/// </summary>
/// <value>
/// <see langword="true"/> if the tool can interact with an unpredictable or dynamic set of entities (like web search).
/// <see langword="false"/> if the tool's domain of interaction is closed and well-defined (like memory access).
/// The default is <see langword="true"/>.
/// <see langword="true"/> if the tool can interact with an unpredictable or dynamic set of entities (like web search);
/// <see langword="false"/> if the tool's domain of interaction is closed and well-defined (like memory access);
/// <see langword="null"/> if unspecified, in which case clients should assume <see langword="true"/>.
/// </value>
[JsonPropertyName("openWorldHint")]
public bool? OpenWorldHint { get; set; }
Expand All @@ -73,9 +73,9 @@ public sealed class ToolAnnotations
/// Gets or sets a value that indicates whether this tool modifies its environment.
/// </summary>
/// <value>
/// <see langword="true"/> if the tool only performs read operations without changing state.
/// <see langword="false"/> if the tool can make modifications to its environment.
/// The default is <see langword="false"/>.
/// <see langword="true"/> if the tool only performs read operations without changing state;
/// <see langword="false"/> if the tool can make modifications to its environment;
/// <see langword="null"/> if unspecified, in which case clients should assume <see langword="false"/>.
/// </value>
/// <remarks>
/// <para>
Expand Down