Skip to content

Commit fbfd0f4

Browse files
committed
docs(changelog): add 0.3.0 release notes
Document the 0.3.0 release with comprehensive changelog entry covering: - StreamableHttp transport feature addition for MCP Inspector compatibility - Framework integration improvements for better developer experience - Technical implementation details including endpoints and session management - Migration guide showing the simple one-line change needed - Clear explanation of backward compatibility guarantees The changelog follows Keep a Changelog format and provides users with all necessary information to understand and adopt the new feature.
1 parent e99fc44 commit fbfd0f4

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

loxone-mcp-rust/CHANGELOG.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,51 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [0.3.0] - 2025-06-30
9+
10+
### Added
11+
12+
#### MCP Inspector Compatibility Enhancement
13+
- **NEW: `StreamableHttp` transport variant** - Added MCP Inspector compatibility to the PulseEngine framework
14+
- Added `TransportConfig::StreamableHttp` enum variant with port and host configuration
15+
- Added `TransportConfig::streamable_http(port)` helper method for easy one-line configuration
16+
- Updated `create_transport()` function to handle StreamableHttp transport creation
17+
- Implements required `/sse` and `/messages` endpoints for MCP Inspector connectivity
18+
- Maintains full backward compatibility with existing HTTP transport usage
19+
20+
#### Framework Integration
21+
- **Enhanced Developer Experience** - Framework applications can now enable MCP Inspector support with a single line change:
22+
- **Before**: `TransportConfig::http(3000)` (not Inspector compatible)
23+
- **After**: `TransportConfig::streamable_http(3000)` (Inspector compatible)
24+
- No breaking changes to existing applications
25+
- Framework-level solution eliminates need to bypass `create_transport()`
26+
27+
### Changed
28+
- Updated all framework package versions from `0.2.0` to `0.3.0` for consistency
29+
- Enhanced transport layer documentation with Inspector compatibility examples
30+
31+
### Technical Details
32+
- **StreamableHttp Transport**: Implements the streamable-http protocol that MCP Inspector expects
33+
- **Session Management**: Automatic session creation and management via `Mcp-Session-Id` headers
34+
- **Endpoint Support**:
35+
- `GET /sse?sessionId=<id>` - Session establishment for Inspector
36+
- `POST /messages` - MCP message exchange endpoint
37+
- `GET /` - Basic server status endpoint
38+
- **Framework Integration**: Seamless integration with PulseEngine framework's `create_transport()` function
39+
40+
### Migration Guide
41+
For applications wanting MCP Inspector compatibility, update transport configuration:
42+
43+
```rust
44+
// Old (still works, but not Inspector compatible)
45+
let transport = create_transport(TransportConfig::http(3001))?;
46+
47+
// New (Inspector compatible)
48+
let transport = create_transport(TransportConfig::streamable_http(3001))?;
49+
```
50+
51+
This change enables MCP Inspector connectivity while maintaining full backward compatibility.
52+
853
## [0.2.0] - 2025-06-29
954

1055
This is a major release that introduces significant improvements to the MCP framework architecture, code quality, and developer experience.

0 commit comments

Comments
 (0)