# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- Production readiness improvements
- MIT LICENSE file for legal compliance
- SECURITY.md with vulnerability disclosure policy
- Comprehensive API documentation (docs/API.md)
- Deployment guide with Docker/PM2/systemd examples (docs/DEPLOYMENT.md)
- Troubleshooting guide with common issues (docs/TROUBLESHOOTING.md)
- Contributing guidelines (docs/CONTRIBUTING.md)
- Dockerfile for containerized deployment
- docker-compose.yml for local deployment
- CI/CD improvements
- Enabled build validation job in GitHub Actions workflow
- Build artifact upload for release tracking
### Fixed
- Security vulnerability in vite dependency (moderate severity)
- Test coverage configuration now excludes archive/ directory for accurate metrics
### Changed
- Updated dependencies to resolve security vulnerabilities
## [1.0.0] - 2025-01-XX
### Added
- Initial release of SmartSuite MCP Server
- 7 MCP tools for SmartSuite API operations:
- smartsuite_query - Query records with filtering and pagination
- smartsuite_record - Create, update, delete records with dry-run safety
- smartsuite_schema - Get table schema with multiple output modes
- smartsuite_discover - Discover tables and field mappings
- smartsuite_intelligent - AI-guided safety analysis
- smartsuite_field_create - Create new fields with validation
- smartsuite_field_update - Update existing fields safely
- Comprehensive type safety with TypeScript strict mode
- 319 unit tests with behavior-driven contracts
- JSON-based knowledge base with 17 patterns (RED/YELLOW/GREEN)
- Field translation system for human-readable field names
- LRU caching for schema and field mappings
- DRY-RUN mode defaulting for all mutations
- MCP protocol compliance with Claude Desktop integration
- CI/CD pipeline with quality gates (lint + typecheck + test)
- Security audit automation with better-npm-audit
### Security
- Environment-based API key management
- Input validation using Zod schemas
- Rate limit error handling (HTTP 429)
- UUID corruption prevention in field operations
- SmartDoc format validation for checklist fields
## [0.9.0] - 2024-12-XX (Beta)
### Added
- Phoenix rebuild with clean architecture
- Test-driven development approach
- Quality gates enforcement (98% coverage threshold)
- Phoenix pattern implementation (extract contracts → discard broken → rebuild clean)
---
## Release Notes Format
### Version Number Guidelines
- **MAJOR**: Breaking changes that require user action
- **MINOR**: New features that are backwards compatible
- **PATCH**: Bug fixes and minor improvements
### Change Categories
- **Added**: New features
- **Changed**: Changes to existing functionality
- **Deprecated**: Soon-to-be removed features
- **Removed**: Removed features
- **Fixed**: Bug fixes
- **Security**: Security improvements
---
## Future Releases
### Planned for v1.1.0
- [ ] Request rate limiting with p-queue
- [ ] Centralized winston logging system
- [ ] Health check endpoint for monitoring
- [ ] Performance benchmarks and SLO tracking
- [ ] Integration tests with live SmartSuite API
- [ ] Update @modelcontextprotocol/sdk to latest version
### Planned for v1.2.0
- [ ] Batch operations optimization
- [ ] WebSocket support for real-time updates
- [ ] Advanced caching strategies with TTL
- [ ] Metrics and observability instrumentation
- [ ] Update to zod v4.x with breaking changes
### Planned for v2.0.0
- [ ] GraphQL API layer (optional)
- [ ] Multi-workspace support
- [ ] Advanced query builder
- [ ] Workflow automation capabilities
---
## Links
- **Repository**: https://github.com/elevanaltd/smartsuite-mcp
- **Documentation**: [docs/](./docs/)
- **Issues**: https://github.com/elevanaltd/smartsuite-mcp/issues
- **Security**: [SECURITY.md](./SECURITY.md)
---
**Maintained by**: EAV Creative Solutions
**License**: MIT
**Last Updated**: 2025-11-11