Changelog
Release Notes
Each public release should give integrators enough information to upgrade safely.
Release Entry Template
## vX.Y.Z - YYYY-MM-DD
### Added
- New SDK helper for creating scoped agent context.
### Changed
- CLI command output now includes cache status.
### Fixed
- MCP recall tool now returns stable empty results when no memory matches.
### Migration
- Rename `oldField` to `newField` before upgrading.
### Compatibility
- REST API: compatible
- TypeScript SDK: compatible
- CLI: compatible
- MCP tools: compatible
Versioning
Use semantic versioning for SDKs and CLI packages:
- Patch releases fix bugs without changing public contracts.
- Minor releases add compatible features.
- Major releases may include breaking changes and require a migration guide.
Public Compatibility Matrix
| Surface | Compatibility signal |
|---|---|
| REST API | Endpoint, request body, response body, and error code changes. |
| SDKs | Package version, language support, and migration notes. |
| CLI | Command names, flags, output shape, and exit codes. |
| MCP | Tool names, input schemas, output schemas, and approval expectations. |
Do not include private operational steps, credentials, account names, resource names, or system details in public release notes.