Skip to content

docs: clarify LoggingTransport log contents #1452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kimjooyoon wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −2
Open

docs: clarify LoggingTransport log contents #1452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,12 @@ SDK, as well as inspecting MCP traffic.
## Collecting MCP logs

For [stdio](protocol.md#stdio-transport) transport connections, you can also
inspect MCP traffic using a `LoggingTransport`:
inspect JSON-RPC messages using a `LoggingTransport`:

`LoggingTransport` logs re-encoded JSON-RPC messages, not the original byte
stream. Whitespace, JSON member order, and transport framing can differ from
the transmitted bytes. To inspect the exact stdio bytes, record the underlying
reads and writes, for example at the `Reader` and `Writer` of an `IOTransport`.

```go
func ExampleLoggingTransport() {
Expand Down
7 changes: 6 additions & 1 deletion internal/docs/troubleshooting.src.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,12 @@ SDK, as well as inspecting MCP traffic.
## Collecting MCP logs

For [stdio](protocol.md#stdio-transport) transport connections, you can also
inspect MCP traffic using a `LoggingTransport`:
inspect JSON-RPC messages using a `LoggingTransport`:

`LoggingTransport` logs re-encoded JSON-RPC messages, not the original byte
stream. Whitespace, JSON member order, and transport framing can differ from
the transmitted bytes. To inspect the exact stdio bytes, record the underlying
reads and writes, for example at the `Reader` and `Writer` of an `IOTransport`.

%include ../../mcp/transport_example_test.go loggingtransport -

Expand Down