Skip to content

docs: clarify LoggingTransport log contents - #1452

Merged
guglielmo-san merged 2 commits into
modelcontextprotocol:mainfrom
kimjooyoon:docs/logging-transport-bytes
Oct 26, 2026
Merged

guglielmo-san merged 2 commits into
modelcontextprotocol:mainfrom
kimjooyoon:docs/logging-transport-bytes

Conversation

@kimjooyoon

Copy link
Copy Markdown
Contributor

LoggingTransport logs decoded JSON-RPC messages after re-encoding them, so its output is not a byte-for-byte recording of stdio traffic. Clarify that distinction in the troubleshooting guide and point readers who need exact bytes to the Reader and Writer of IOTransport.

Regenerated docs/troubleshooting.md from its source with the repository's weave generator. As a control, generating the unchanged source reproduced the existing document byte for byte. The final patch changes the same paragraph in both files and passes git apply --check --whitespace=error-all. This is a documentation-only change; no SDK implementation or examples changed.

Explain that LoggingTransport re-encodes JSON-RPC messages and does not preserve the original byte stream. Point stdio byte-level diagnostics to the underlying IOTransport readers and writers, and regenerate the corresponding guide.
@kimjooyoon
kimjooyoon marked this pull request as ready for review October 25, 2026 18:33
@guglielmo-san
guglielmo-san enabled auto-merge (squash) October 26, 2026 13:46
@guglielmo-san

Copy link
Copy Markdown
Contributor

@kimjooyoon thank you for the contribution. You will have to update the branch and then it will be ready for merge

kimjooyoon commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor Author

Thanks for reviewing! Updated the branch with the latest main in fc086eb. The changes to the source and generated troubleshooting docs are unchanged. The new workflow runs currently show action_required.

@guglielmo-san
guglielmo-san merged commit 8f43396 into modelcontextprotocol:main Oct 26, 2026
9 of 10 checks passed
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.

2 participants