BUGS.md•4.74 kB
# Known Issues and Bug Tracking
This document tracks known issues, bugs, and their resolution status for the RescueTime MCP Server.
## How to Report Bugs
Please report bugs by creating a GitHub Issue with the following information:
### Bug Report Template
```
**Bug Description**
A clear description of what the bug is.
**Environment**
- OS: [e.g. macOS 13.0, Ubuntu 22.04, Windows 11]
- Python version: [e.g. 3.9.5]
- Package version: [e.g. 0.1.0]
**To Reproduce**
Steps to reproduce the behavior:
1. Set up environment with '...'
2. Run command '...'
3. Call function '...'
4. See error
**Expected Behavior**
A clear description of what you expected to happen.
**Actual Behavior**
What actually happened, including error messages.
**Additional Context**
- Log output (if any)
- Configuration details
- Any other relevant information
```
## Current Known Issues
### Status Legend
- 🔴 **Critical**: Blocks core functionality
- 🟡 **Major**: Affects important features but has workarounds
- 🟢 **Minor**: Small issues or improvements
- ✅ **Fixed**: Resolved in latest version
### Active Issues
🟡 **Major**: **Alert Dismissal API Limitation**
- **Issue**: `dismiss_alert` and `get_alerts_feed` with `op=dismiss` are not supported by the RescueTime API
- **Status**: API limitation, not a bug in our implementation
- **Workaround**: Methods now return clear error messages directing users to the RescueTime web interface
- **Impact**: Alert dismissal must be done manually through RescueTime's web interface
### Working Features
This project has been thoroughly tested with the following confirmed working:
- ✅ 9 out of 11 RescueTime API endpoints fully functional
- ✅ Alert dismissal properly documented as API limitation with clear error messages
- ✅ Unit tests covering all major functionality
- ✅ Integration tests with real API interactions
- ✅ Error handling and edge cases covered
- ✅ Type safety and static analysis passing
## Resolved Issues
### Version 0.1.0 Release (2025-08-17)
All major issues identified during development and testing have been resolved:
**Development Issues:**
- ✅ **API Key Security**: Removed hardcoded API keys from source code
- ✅ **Error Handling**: Comprehensive error handling for all API endpoints
- ✅ **Type Safety**: Full type coverage with mypy static analysis
- ✅ **Documentation**: Complete documentation for all features
- ✅ **Testing**: 100% test coverage for core functionality
**Runtime Issues Identified and Fixed:**
- ✅ **get_analytic_data Parameter Issues**: Fixed Pydantic enum serialization with `mode="json"`
- ✅ **get_focus_session_status 404 Errors**: Fixed by using correct `focustime_started_feed` endpoint
- ✅ **start_focus_session Parameter Validation**: Fixed by providing proper defaults (30 minutes)
- ✅ **post_offline_time Input Validation**: Fixed `Union[int, float]` type issue by using `float`
- ✅ **Invalid "member" Perspective**: Removed invalid enum value, only "rank" and "interval" supported
- ✅ **Output Validation Errors**: Enhanced response handling for non-JSON API responses
**API Limitations Documented:**
- 🟡 **dismiss_alert**: Documented as RescueTime API limitation with helpful error messages
- 🟡 **get_alerts_feed dismiss operations**: Documented as RescueTime API limitation
## Testing Status
The following components have been thoroughly tested:
### API Endpoints Status
- ✅ Analytic Data API (rank and interval perspectives)
- ✅ Daily Summary Feed API
- ✅ Alerts Feed API (list operation)
- 🟡 Alert Dismissal API (API limitation - documented)
- ✅ Highlights Feed API
- ✅ Highlights Post API
- ✅ FocusTime Start/End/Status APIs (all working after fixes)
- ✅ Offline Time API (fixed parameter validation)
- ✅ Health Check API
### Error Scenarios ✅
- [x] Invalid API keys
- [x] Network timeouts
- [x] Rate limiting
- [x] Invalid parameters
- [x] Server errors
### Development Environment ✅
- [x] Python 3.9+ compatibility
- [x] Cross-platform support (macOS, Linux, Windows)
- [x] Development tooling (linting, formatting, type checking)
- [x] CI/CD pipeline compatibility
## Reporting Security Issues
For security-related issues, please:
1. **Do NOT** create a public GitHub issue
2. Email the maintainer directly at: ebowman@boboco.ie
3. Include "SECURITY" in the subject line
4. Provide detailed information about the vulnerability
## Contributing to Bug Fixes
If you'd like to help fix bugs:
1. Check the GitHub Issues page for open bugs
2. Comment on the issue to indicate you're working on it
3. Follow the Contributing Guidelines in CONTRIBUTING.md
4. Submit a Pull Request with your fix
Thank you for helping improve the RescueTime MCP Server!