docs: add comprehensive transport and middleware chapters #81
Conversation
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
Complete rewrite of Chapter 10 transport chapters with SDK-accurate content: - ch10-01-websocket.md: WebSocket client + optional server transport with correct examples using WebSocketTransport, WebSocketConfig, and WebSocketServerTransport. Documented feature flag and optional server capabilities. - ch10-02-http.md: HTTP client transport fundamentals with correct examples using HttpTransport and HttpConfig. Clarified SSE support and directed readers to Streamable HTTP for server deployments. - ch10-03-streamable-http.md: Streamable HTTP server (Axum-based) and client with accurate examples using StreamableHttpServer, StreamableHttpServerConfig, StreamableHttpTransport. Documented stateless vs stateful modes, protocol headers, and Accept negotiation. - ch10-transports.md: Updated WebSocket section to reflect client + optional server support, corrected feature flags, and added deployment guidance. All examples verified with: cargo check --examples --features "streamable-http websocket" 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Complete Chapter 11 middleware documentation covering: - Basic Middleware trait for simple request/response interception - Advanced AdvancedMiddleware with priority ordering, context propagation, conditional execution, and lifecycle hooks - MiddlewareContext for sharing data and metrics across middleware layers - MiddlewarePriority for controlling execution order (Critical, High, Normal, Low, Lowest) - Built-in middleware implementations: * LoggingMiddleware - configurable logging levels * AuthMiddleware - authentication support * RetryMiddleware - retry logic with exponential backoff * RateLimitMiddleware - token bucket rate limiting * CircuitBreakerMiddleware - fault tolerance with state management * MetricsMiddleware - performance and usage metrics * CompressionMiddleware - large message compression - Custom middleware examples (basic and advanced) - Middleware ordering best practices and principles - Performance considerations and optimization techniques - Examples reference: examples/15_middleware.rs, examples/30_enhanced_middleware.rs, and inline doctests in src/shared/middleware.rs All code examples verified against SDK implementation. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR adds comprehensive documentation for transports and middleware in the pmcp-book:
Chapter 10: Transports
ch10-transports.md: Complete overview of transport abstraction (32 → 917 lines)
ch10-01-websocket.md: WebSocket client transport (97 lines)
ch10-02-http.md: HTTP client transport (70 lines)
ch10-03-streamable-http.md: Streamable HTTP transport (121 lines)
Chapter 11: Middleware
Testing
make test)make quality-gate)Verification
All chapters verified for:
Related
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com