CHANGELOG.md•4.14 kB
# 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]
### Planned
- Module development documentation indexing
- Component architecture documentation (Forms, Grids, etc.)
- Theme development documentation
- API reference documentation (Admin API, Webservices)
- Enhanced search with filters and ranking
- PyPI publication for easier installation
## [0.1.0] - 2025-11-24
### Added - MVP Release
#### Core Features
- **648 PrestaShop Hooks Indexed**: Complete coverage of all PrestaShop hooks
- Display hooks (122)
- Action hooks (500)
- Other hooks (26)
- **SQLite FTS5 Full-Text Search**: Lightning-fast search (<50ms response time)
- **Offline-First Architecture**: All documentation included locally, no network required
- **3 MCP Tools**:
- `search_prestashop_hooks`: Search hooks with filters (type, origin)
- `get_prestashop_hook`: Get complete documentation for a specific hook
- `list_prestashop_hooks`: List all hooks organized by type and origin
#### Documentation
- Complete README with installation and usage instructions
- CONTRIBUTING guide for developers
- MIT License
- Comprehensive test suite
#### Parser & Indexing
- YAML frontmatter parser for hook files
- Support for hook metadata: type, origin, locations, descriptions
- Code example extraction from markdown
- GitHub reference linking
- Hook aliases support
- Null value handling in YAML fields
#### Database Schema
- Main documentation table with FTS5 indexing
- Specialized hooks table with metadata
- Efficient indexes on category, type, and origin fields
#### IDE Integration
- Claude Desktop configuration (native and Docker)
- VS Code integration via `.mcp.json` (native and Docker)
- Cursor editor support (native and Docker)
- Zed editor support (native and Docker)
#### Docker Support
- Multi-stage Dockerfile for optimized image size (~150 MB)
- docker-compose.yml for easy deployment
- GitHub Container Registry publishing
- Multi-platform support (amd64, arm64)
- Persistent volume for database storage
- Health checks and monitoring
- Comprehensive Docker documentation (DOCKER.md)
- Docker CI/CD workflow with security scanning
#### Testing
- 4 unit tests for parsing and indexing
- Comprehensive integration tests
- MCP protocol compliance tests
- 100% pass rate on all tests
#### Performance
- Database indexing: ~3 seconds for 648 hooks
- Search queries: <50ms average
- Hook retrieval: <10ms average
- MCP call roundtrip: <200ms average
### Technical Details
- **Python**: 3.10+ required
- **Dependencies**:
- fastmcp: MCP server framework
- sqlite-utils: Database management
- pyyaml: YAML parsing
- **Database**: SQLite with FTS5 extension
- **Protocol**: Model Context Protocol (MCP) 2024-11-05
- **Transport**: stdio
### Documentation Coverage
- **Hooks**: 648 files (~2.6 MB)
- Core hooks: 581
- Theme hooks: 59
- Module hooks: 7
- Unknown origin: 1
### Known Limitations
- MVP focuses on hooks only (modules, components, themes, APIs coming in future releases)
- 26 hooks have `type: unknown` due to null values in source documentation
- Search is keyword-based (semantic search planned for future)
## [0.0.1] - 2025-11-24
### Added
- Initial project structure
- Basic package configuration
---
## Release Notes Format
### Types of Changes
- **Added**: New features
- **Changed**: Changes in existing functionality
- **Deprecated**: Soon-to-be removed features
- **Removed**: Removed features
- **Fixed**: Bug fixes
- **Security**: Vulnerability fixes
### Version Numbering
- **MAJOR.MINOR.PATCH** (e.g., 1.2.3)
- **MAJOR**: Incompatible API changes
- **MINOR**: Backward-compatible functionality
- **PATCH**: Backward-compatible bug fixes
---
[Unreleased]: https://github.com/florinel-chis/prestashop-mcp/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/florinel-chis/prestashop-mcp/releases/tag/v0.1.0
[0.0.1]: https://github.com/florinel-chis/prestashop-mcp/releases/tag/v0.0.1