Skip to content

Commit 3faffdf

Browse files
CopilotCopilot
andcommitted
Fix XML doc comment issues in Protocol types
- BlobResourceContents.cs: Fix 'an' to 'a' before 'BlobResourceContents' (consonant sound) - BlobResourceContents.cs: Remove empty <exception> tag on FromBytes (method doesn't throw) - CompletionsCapability.cs: Fix 'sampling capabilities' to 'completions capabilities' (copy-paste error) - ContentBlock.cs: Wrap dangling comment in <remarks> tag and fix double space Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 7bd866e commit 3faffdf

3 files changed

Lines changed: 5 additions & 4 deletions

File tree

src/ModelContextProtocol.Core/Protocol/BlobResourceContents.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,12 @@ public sealed class BlobResourceContents : ResourceContents
3232
private ReadOnlyMemory<byte>? _blob;
3333

3434
/// <summary>
35-
/// Creates an <see cref="BlobResourceContents"/> from raw data.
35+
/// Creates a <see cref="BlobResourceContents"/> from raw data.
3636
/// </summary>
3737
/// <param name="bytes">The raw unencoded data.</param>
3838
/// <param name="uri">The URI of the blob resource.</param>
3939
/// <param name="mimeType">The optional MIME type of the data.</param>
4040
/// <returns>A new <see cref="BlobResourceContents"/> instance.</returns>
41-
/// <exception cref="InvalidOperationException"></exception>
4241
public static BlobResourceContents FromBytes(ReadOnlyMemory<byte> bytes, string uri, string? mimeType = null)
4342
{
4443
return new(bytes, uri, mimeType);

src/ModelContextProtocol.Core/Protocol/CompletionsCapability.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ namespace ModelContextProtocol.Protocol;
2222
/// </para>
2323
/// <para>
2424
/// This class is intentionally empty as the Model Context Protocol specification does not
25-
/// currently define additional properties for sampling capabilities. Future versions of the
25+
/// currently define additional properties for completions capabilities. Future versions of the
2626
/// specification might extend this capability with additional configuration options.
2727
/// </para>
2828
/// </remarks>

src/ModelContextProtocol.Core/Protocol/ContentBlock.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,10 @@ private protected ContentBlock()
6969
/// <summary>
7070
/// Provides a <see cref="JsonConverter"/> for <see cref="ContentBlock"/>.
7171
/// </summary>
72-
/// Provides a polymorphic converter for the <see cref="ContentBlock"/> class that doesn't require
72+
/// <remarks>
73+
/// Provides a polymorphic converter for the <see cref="ContentBlock"/> class that doesn't require
7374
/// setting <see cref="JsonSerializerOptions.AllowOutOfOrderMetadataProperties"/> explicitly.
75+
/// </remarks>
7476
[EditorBrowsable(EditorBrowsableState.Never)]
7577
public sealed class Converter : JsonConverter<ContentBlock>
7678
{

0 commit comments

Comments
 (0)