Skip to content

Docs edit pass#1451

Open
gewarren wants to merge 3 commits intomodelcontextprotocol:mainfrom
gewarren:edit-pass-0326
Open

Docs edit pass#1451
gewarren wants to merge 3 commits intomodelcontextprotocol:mainfrom
gewarren:edit-pass-0326

Conversation

@gewarren
Copy link
Contributor

  • Use xref links for APIs.
  • Add sentence punctuation on code comments and bullet points.
  • Use sentence casing for headings.
  • Spell out e.g. as 'for example'.
  • Format tables.

Fixes dotnet/docs#52088.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

[Logging utility]: https://modelcontextprotocol.io/specification/2025-11-25/server/utilities/logging

This document describes how to implement logging in MCP servers and how clients can consume log messages.
This article describes how to implement logging in MCP servers and how clients can consume log messages.
Copy link
Contributor

@stephentoub stephentoub Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why change document to article? The latter sounds worse to me, especially in this context.

stephentoub
stephentoub previously approved these changes Mar 20, 2026
@gewarren
Copy link
Contributor Author

Seems like a bunch of the xrefs are broken. I will fix them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Review MCP SDK docs

2 participants