Add CHANGELOG

CHANGELOG.md

@@ -0,0 +1,69 @@
+# 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.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Changed
+- `_cleanup_expired` now runs on a background daemon thread — never blocks the calling request
+- Cleanup removed from read paths; only writes trigger it
+- `get_knowledge` tool now accepts `source`, `tags`, and `entry_type` params for filtered queries
+- Suppression tags stored only in entry envelope (removed duplicate `data.tags` field)
+- Tool descriptions include structured error contract (unstructured errors = transport/platform failure)
+- Demo screenshot resized and repositioned in README
+
+### Added
+- Tools reference section in README documenting all 14 MCP tools
+- 5 new tests for filtered knowledge queries and suppression tag deduplication (129 total)
+
+### Fixed
+- Data model inconsistency: suppression tag matching now uses envelope `tags` instead of `data.tags`
+
+## [0.2.0] - 2026-03-20
+
+### Added
+- **Storage abstraction**: `Store` protocol with `SQLiteStore` default implementation — future backends swap without changing collator or server
+- **Soft delete**: `delete_entry` moves to trash (30-day retention), `restore_entry` recovers, `get_deleted` lists trash
+- **Bulk delete safety**: dry-run by default, requires `confirm=True`
+- **Secure deployment**: secret path auth via `AWARENESS_MOUNT_PATH` env var with server middleware
+- **Docker Compose**: named Cloudflare Tunnel and ephemeral quick tunnel profiles
+- **Streamable HTTP transport**: `AWARENESS_TRANSPORT=streamable-http` for remote clients
+- **Read tools**: mirrors of all resources for tools-only MCP clients (Claude.ai)
+- **Knowledge tools**: `learn_pattern`, `add_context`, `set_preference`, `get_knowledge`
+- **Suppression tag matching**: checks alert content fields (alert_id, message), not just structural tags
+- **Data dictionary**: full schema documentation for entries table and all 6 entry types
+- **Deployment guide**: walkthrough with Cloudflare Tunnel, WAF, and Claude.ai connector setup
+- **Issue templates**: bug report, feature request, platform test report
+- **GitHub Sponsors**: FUNDING.yml with 4 monthly tiers
+- **CI pipeline**: ruff, mypy (strict), pytest via GitHub Actions on push/PR to main
+- 124 tests with strict type checking
+
+### Changed
+- README reframed from monitoring to portable knowledge store
+- Demo data reworked to show knowledge store capabilities (not just NAS monitoring)
+- `poc-demo.md` renamed to `deployment-guide.md`
+- License changed from MIT to Apache 2.0
+
+## [0.1.0] - 2026-03-18
+
+Initial implementation.
+
+### Added
+- **Core server**: FastMCP server with stdio transport
+- **Entry types**: status, alert, pattern, suppression, context, preference
+- **Collator**: briefing generation with suppression and pattern application
+- **Briefing resource**: `awareness://briefing` — compact, token-optimized summary
+- **Drill-down resources**: alerts, status, knowledge, suppressions
+- **Three-layer detection model**: threshold and knowledge layers (baseline planned)
+- **Pattern matching**: word-overlap between effect strings and alert fields
+- **Suppression system**: time-based expiry with escalation overrides (critical breaks through)
+- **SQLite backend**: WAL mode, threading.Lock for async safety
+- **Dockerfile** for container deployment
+- Design docs: core spec and collation layer
+
+[Unreleased]: https://github.com/cmeans/mcp-awareness/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/cmeans/mcp-awareness/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/cmeans/mcp-awareness/releases/tag/v0.1.0