All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Random Sound Option: Set
MCP_NOTIFICATION_SOUND=randomto randomly play one of the 5 bundled sounds 🎲 - Bundled Sound Assets: MP3 files now included in npm package for out-of-the-box functionality
- NPX Compatibility: Full support for
npx @pinkpixel/notification-mcpwith bundled sounds - Enhanced Configuration:
MCP_NOTIFICATION_SOUNDenvironment variable for choosing bundled sounds - Priority Configuration System: Custom path > bundled sound > default gentle chime
- MIT License: Added proper open source license file
- CONTRIBUTING.md: Comprehensive contribution guidelines and development setup
- Package Binary: Added
notification-mcpbinary entry for easier CLI usage - Enhanced Package Metadata: Keywords, author info, repository links, and bug reporting
- Asset Resolution: Updated to use
import.meta.urlinstead ofprocess.cwd()for reliable asset location - Sound File Structure: Moved all MP3 files into dedicated
sounds/directory - Package.json: Added
soundsdirectory to files array for npm distribution - README.md: Complete rewrite with bundled sound examples and modern documentation
- OVERVIEW.md: Updated with bundled asset information and enhanced configuration details
- Code Structure: Added
fileURLToPathimport and__dirnamecalculation for ES modules
- NPX Sound Loading: Bundled sounds now work correctly when run via npx
- Asset Path Resolution: Fixed path resolution issues that prevented sound loading in various environments
- Environment Variable Priority: Proper handling of configuration precedence
- ES Module Compatibility: Full ES module support with proper asset resolution
- Build Process: Enhanced to include sound assets in distribution
- Documentation: Added comprehensive documentation suite (README, OVERVIEW, CHANGELOG, CONTRIBUTING)
- Error Handling: Improved error messages and debugging information
- Cross-Platform: Maintained Windows and macOS compatibility with enhanced reliability
- Initial release of Notification MCP Server
- Basic
play_notificationtool implementation - Support for custom MP3 file paths via
MCP_NOTIFICATION_SOUND_PATH - Cross-platform audio playback (Windows and macOS)
- TypeScript implementation with MCP SDK
- Basic documentation and setup instructions