Releases: conikeec/mcpr
<
7869
/div>
Releases · conikeec/mcpr
MCPR 0.2.1 (Important Update)
⚠️ IMPORTANT NOTICE
Version 0.2.0 has been yanked due to critical issues with the SSE transport implementation. This release (0.2.1) includes important fixes for client-server communication, message handling, and template generation. If you're already using 0.2.0, we strongly recommend upgrading to 0.2.1 to avoid potential issues.
What's New in 0.2.1
Added
- Server-Sent Events (SSE) transport implementation
- Client registration and unique client ID assignment
- Client-specific message queues
- Polling mechanism for clients to receive messages
- Proper error handling and logging
- Support for all MCP message types
- Comprehensive documentation for generating and testing projects
- Detailed instructions for both stdio and SSE transports
- Troubleshooting guides for common issues
- Advanced testing scenarios
Fixed
- SSE transport message handling
- Fixed client message queue management
- Improved HTTP request routing for SSE endpoints
- Enhanced error handling for network issues
- Added proper timeout handling for message reception
- Template generation for SSE projects
- Updated templates to use the correct transport configuration
- Fixed dependency management in generated projects
Improved
- Enhanced logging throughout the codebase
- Added detailed debug and trace logging
- Improved error messages for better troubleshooting
- Updated README with comprehensive testing guide
- Step-by-step instructions for generating and testing projects
- Examples of expected output for both transport types
- Common issues and their solutions
How to Update
Update your Cargo.toml
to use version 0.2.1:
[dependencies]
mcpr = "0.2.1"
Or run:
cargo add mcpr@0.2.1
7. Check "This is a pre-release" if you want to indicate it's a quick fix release
8. Click "Publish release"
## 4. Create a GitHub Discussion or Issue
You might also want to create a GitHub Discussion or Issue to highlight the changes and warn users. Here's a template for that:
**Title**: Important: Version 0.2.0 yanked, please use 0.2.1
**Body**:
```markdown
## ⚠️ Important Notice for All MCPR Users
We've recently discovered critical issues with the SSE transport implementation in version 0.2.0 of MCPR. As a result, we've yanked version 0.2.0 from crates.io and released version 0.2.1 with fixes for these issues.
### What This Means For You
- If you're using version 0.2.0, please update to 0.2.1 as soon as possible
- If you're experiencing issues with client-server communication, message handling, or template generation, updating to 0.2.1 should resolve these problems
- All new projects should use version 0.2.1 or later
### Key Fixes in 0.2.1
- Fixed client message queue management in SSE transport
- Improved HTTP request routing for SSE endpoints
- Enhanced error handling for network issues
- Added proper timeout handling for message reception
- Fixed template generation for SSE projects
### How to Update
Update your `Cargo.toml` to use version 0.2.1:
```toml
[dependencies]
mcpr = "0.2.1"
Or run:
cargo add mcpr@0.2.1
If you encounter any issues after updating, please let us know by opening an issue.
Thank you for your understanding and continued support!
## 5. Update crates.io Documentation
The README changes you've made will automatically be reflected on crates.io when users view your package, as crates.io displays the README from your GitHub repository.
## Summary
By implementing these steps, you've effectively:
1. Added a prominent warning in the README about the yanked 0.2.0 version
2. Updated the installation instructions to explicitly recommend version 0.2.1
3. Prepared instructions for creating a GitHub release with detailed information about the changes and fixes
4. Prepared a template for a GitHub Discussion or Issue to further communicate the changes
These actions will help ensure that users are aware of the issues with version 0.2.0 and know to use version 0.2.1 instead. The multiple communication channels (README, GitHub release, and potentially a Discussion or Issue) increase the likelihood that users will see this important information.