RELEASE_NOTES_v1.0.0.mdโข4.6 kB
# OpenSCAD MCP Server v1.0.0 - Production Release ๐
**Release Date:** August 25, 2025
**Status:** Production Ready
**Test Coverage:** 100% Success Rate
## Overview
We are excited to announce the production release of OpenSCAD MCP Server v1.0.0! This release marks a significant milestone with full FastMCP 2.11.3 compatibility, comprehensive testing, and production-ready documentation.
## Key Highlights
### โ
Production Ready
- **100% test success rate** across all integration tests
- Full compatibility with FastMCP 2.11.3
- Comprehensive error handling and validation
- Production-grade documentation
### ๐ Core Features
- **Three Primary Tools:**
- `render_single` - Single view rendering with complete camera control
- `render_perspectives` - Multiple perspective generation (8 standard views)
- `check_openscad` - OpenSCAD installation verification
- **Advanced Rendering:**
- Base64 PNG image encoding for seamless integration
- Variable injection for parametric models
- Auto-centering option
- Custom color scheme support
- Async/await support for non-blocking operations
### ๐ Performance Metrics
- Single view rendering: ~1-3 seconds
- Multiple perspectives: ~5-10 seconds for 8 views
- Memory footprint: ~50 MB base + 10-20 MB per render
- Base64 encoding overhead: < 0.1 seconds
## Installation
### From PyPI (Recommended)
```bash
pip install openscad-mcp-server==1.0.0
```
### From Distribution Package
```bash
pip install openscad_mcp_server-1.0.0-py3-none-any.whl
```
### Using UV (Faster Alternative)
```bash
uv pip install openscad-mcp-server==1.0.0
```
## Dependencies
- FastMCP == 2.11.3
- Pydantic == 2.11.7
- Pillow >= 10.0.0
- PyYAML >= 6.0
- Python >= 3.8
## Breaking Changes from Pre-1.0
### Import Changes
```python
# Old (pre-1.0)
from openscad_mcp import RenderOptions
# New (1.0.0)
from openscad_mcp import RenderParams
```
### Configuration Updates
- Environment variables now use `MCP_` prefix
- Standardized configuration file format
- Updated dependency versions
## What's Fixed
- โ
Removed deprecated `fastmcp.types.Tool` import
- โ
Updated FastMCP initialization to use simplified constructor
- โ
Fixed import name mismatches in `__init__.py`
- โ
Resolved Pydantic deprecation warnings
- โ
Updated all type definitions to modern Pydantic syntax
## Documentation
- [README.md](README.md) - Getting started guide
- [API.md](API.md) - Complete API reference
- [DEPLOYMENT.md](DEPLOYMENT.md) - Production deployment guide
- [CHANGELOG.md](CHANGELOG.md) - Detailed change history
## Security Features
- Input validation on all tool parameters
- Timeout protection for long-running renders
- Safe file path handling
- Environment variable isolation
- No hardcoded secrets
## Known Limitations
- Turntable animation currently returns single frame (full implementation in v1.1.0)
- ImageMagick integration pending
- Advanced caching mechanism not yet implemented
## Future Roadmap
### v1.1.0 (Next Release)
- Full turntable animation support
- ImageMagick integration
- Advanced caching mechanism
- Enhanced queue management
### v1.2.0
- STL export support
- Multi-format output (SVG, DXF)
- Batch rendering optimization
## Deployment Checklist
Before deploying to production:
- [ ] Verify Python 3.8+ installed
- [ ] OpenSCAD installed and accessible
- [ ] Configure environment variables
- [ ] Test installation in clean environment
- [ ] Review security settings
- [ ] Set up monitoring
## Testing
Run the included test suite:
```bash
python -m pytest tests/
```
Verify installation:
```bash
python -m openscad_mcp.server --health-check
```
## Support
- **Issues:** Report bugs via GitHub Issues
- **Documentation:** See included documentation files
- **License:** MIT License
## Contributors
Thanks to everyone who contributed to making this release possible through development, testing, documentation, and feedback!
## Upgrade Instructions
For users upgrading from pre-release versions:
1. Uninstall old version:
```bash
pip uninstall openscad-mcp-server
```
2. Install new version:
```bash
pip install openscad-mcp-server==1.0.0
```
3. Update configuration files with new environment variables
4. Test your integration with the new version
## Download
- **Wheel Package:** `openscad_mcp_server-1.0.0-py3-none-any.whl`
- **Source Distribution:** `openscad_mcp_server-1.0.0.tar.gz`
- **Repository:** Available in `/dist` directory
---
**Thank you for choosing OpenSCAD MCP Server!**
For the latest updates and announcements, follow the project repository.