Fix XML documentation spelling, grammar, and correctness issues across SDK#1372
Merged
stephentoub merged 9 commits intomainfrom Feb 24, 2026
Merged
Fix XML documentation spelling, grammar, and correctness issues across SDK#1372stephentoub merged 9 commits intomainfrom
stephentoub merged 9 commits intomainfrom
Conversation
- McpException.cs: Fix 'an Model' → 'a Model' (incorrect article) - ProtectedResourceMetadata.cs: Fix 'RFC 9396' → 'RFC 9728' (wrong RFC number) - AIContentExtensions.cs: Fix see cref 'TextContentBlock' → 'TextContent' (wrong type) - ClientOAuthProvider.cs: Fix exception cref 'InvalidOperationException' → 'McpException' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- McpSession.Methods.cs: Fix param description for resultTypeInfo (was 'request parameter' instead of 'result') - McpSession.cs: Fix 'base interface' → 'base class' and remove incorrect 'interfaces' label - McpSession.cs: Fix IDisposable → IAsyncDisposable in returns tag - NotificationHandlers.cs: Fix typo 'circument' → 'circumvent' - ProcessHelper.cs: Fix typo 'dieing' → 'dying' - RequestOptions.cs: Fix 'is not impacting by' → 'is not impacted by' - RequestOptions.cs: Fix see cref from JsonSerializer to JsonSerializerOptions - McpSessionHandler.cs: Fix missing 'to' in 'It is strongly recommended use' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- 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>
stephentoub
approved these changes
Feb 24, 2026
src/ModelContextProtocol.Core/Authentication/ProtectedResourceMetadata.cs
Outdated
Show resolved
Hide resolved
Contributor
@copilot please continue |
Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Contributor
Author
Applied all 67 fixes from the audit in 81dadfd. This covers wrong |
jeffhandley
previously approved these changes
Feb 24, 2026
stephentoub
approved these changes
Feb 24, 2026
src/ModelContextProtocol.AspNetCore/HttpMcpServerBuilderExtensions.cs
Outdated
Show resolved
Hide resolved
src/ModelContextProtocol.Core/Authentication/ProtectedResourceMetadata.cs
Outdated
Show resolved
Hide resolved
jeffhandley
approved these changes
Feb 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes ~67 XML doc comment issues in
src/ranging from typos to incorrectsee creftargets, plus one non-doc string concatenation bug. All fixes are applied.Issues Fixed
Wrong
see crefreferencesMcpServerPrompt.cs,McpServerTool.cs,McpServerResource.cs: Multiple overloads referencedDelegateinstead ofMethodInfo, andAIFunctioninstead of the correctMcpServer*type in<param>and<returns>tagsElicitRequestParams.cs: Converter summary referencedResourceContentsinstead ofPrimitiveSchemaDefinition; orphaned text wrapped in<remarks>ListRootsRequestParams.cs: ReferencedRequestMethods.ResourcesTemplatesListinstead ofRootsListIClientTransport.cs: TautologicalMcpClientreference changed toMcpClient.CreateAsyncCompletionsCapability.cs,LoggingCapability.cs: Said "sampling capabilities" (copy-paste fromSamplingCapability)Wrong actor/direction descriptions
McpClientHandlers.cs: Said "behavior of the MCP server" — changed to "client"; said client sendsroots/list— server sends itRootsListChangedNotificationParams.cs: Said issued by servers — issued by clientsMcpSession.Methods.cs: Said "to the server" — changed to "to the connected session" (base class for both client and server)Spelling and typos
setialization→initialization,sor→or,advertizes/advertize→advertises/advertise,templates's→template's,members's→member's,addition→additional,circument→circumvent,dieing→dyingGrammar
an large→a large,An primitive→A primitive, missing verbs ("notification be issued" → "can be issued"), missing words ("asking it initialize" → "asking it to initialize"), missing articles ("The name of notification" → "The name of the notification"),an specification→a specificationMalformed XML
<see false="false"/>→<see langword="false"/>,<p>→<para>, duplicate<returns>tags removed, orphaned text wrapped in<remarks>, stray"/>fragment removed, empty<exception>tag removed, missing period addedCopy-paste errors
McpServerResource.cs: ProtocolResource remarks incorrectly described ProtocolResourceTemplateMcpServerBuilderExtensions.cs:call_prompt→prompts/get; "prompts should be sourced" → "resources should be sourced" on WithResources methodMcpAuthenticationExtensions.cs: "authorization" → "authentication" (×3)ProtectedResourceMetadata.cs: Simplified summary per reviewer feedbackMinor
Messages→messages,Urls→URLs, wrong<param name>in EquatableArray, duplicate<exception>tag removedNon-doc fix
McpServerBuilderExtensions.cs: Missing space in string concatenation for error messages (×3) — produced "metadataand" at runtime🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.