Skip to content

Comments

Fix XML documentation spelling, grammar, and correctness issues across SDK#1372

Merged
stephentoub merged 9 commits intomainfrom
copilot/review-xml-comments
Feb 24, 2026
Merged

Fix XML documentation spelling, grammar, and correctness issues across SDK#1372
stephentoub merged 9 commits intomainfrom
copilot/review-xml-comments

Conversation

Copy link
Contributor

Copilot AI commented Feb 24, 2026

Fixes ~67 XML doc comment issues in src/ ranging from typos to incorrect see cref targets, plus one non-doc string concatenation bug. All fixes are applied.

Issues Fixed

Wrong see cref references

  • McpServerPrompt.cs, McpServerTool.cs, McpServerResource.cs: Multiple overloads referenced Delegate instead of MethodInfo, and AIFunction instead of the correct McpServer* type in <param> and <returns> tags
  • ElicitRequestParams.cs: Converter summary referenced ResourceContents instead of PrimitiveSchemaDefinition; orphaned text wrapped in <remarks>
  • ListRootsRequestParams.cs: Referenced RequestMethods.ResourcesTemplatesList instead of RootsList
  • IClientTransport.cs: Tautological McpClient reference changed to McpClient.CreateAsync
  • CompletionsCapability.cs, LoggingCapability.cs: Said "sampling capabilities" (copy-paste from SamplingCapability)

Wrong actor/direction descriptions

  • McpClientHandlers.cs: Said "behavior of the MCP server" — changed to "client"; said client sends roots/list — server sends it
  • RootsListChangedNotificationParams.cs: Said issued by servers — issued by clients
  • McpSession.Methods.cs: Said "to the server" — changed to "to the connected session" (base class for both client and server)

Spelling and typos

  • setializationinitialization, soror, advertizes/advertizeadvertises/advertise, templates'stemplate's, members'smember's, additionadditional, circumentcircumvent, dieingdying

Grammar

  • an largea large, An primitiveA 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 specificationa specification

Malformed 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 added

Copy-paste errors

  • McpServerResource.cs: ProtocolResource remarks incorrectly described ProtocolResourceTemplate
  • McpServerBuilderExtensions.cs: call_promptprompts/get; "prompts should be sourced" → "resources should be sourced" on WithResources method
  • McpAuthenticationExtensions.cs: "authorization" → "authentication" (×3)
  • ProtectedResourceMetadata.cs: Simplified summary per reviewer feedback

Minor

  • Double spaces, missing articles, missing commas, inconsistent "Streaming" vs "Streamable" terminology, Messagesmessages, UrlsURLs, wrong <param name> in EquatableArray, duplicate <exception> tag removed

Non-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.

Copilot AI and others added 4 commits February 24, 2026 02:50
- 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 stephentoub marked this pull request as ready for review February 24, 2026 03:50
@stephentoub
Copy link
Contributor

No code changes were made — this PR is the audit report only, as the session timed out before fixes could be applied.

@copilot please continue

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 24, 2026

No code changes were made — this PR is the audit report only, as the session timed out before fixes could be applied.

@copilot please continue

Applied all 67 fixes from the audit in 81dadfd. This covers wrong see cref references, actor/direction errors, spelling/grammar typos, malformed XML tags, copy-paste errors, and string concatenation issues. Build passes with 0 warnings and all tests pass.

@jeffhandley jeffhandley added the documentation Improvements or additions to documentation label Feb 24, 2026
jeffhandley
jeffhandley previously approved these changes Feb 24, 2026
@stephentoub stephentoub merged commit 3cc4863 into main Feb 24, 2026
8 of 10 checks passed
@stephentoub stephentoub deleted the copilot/review-xml-comments branch February 24, 2026 04:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants