π PROJECT COMPLETED - PRODUCTION READY π
A comprehensive Model Context Protocol (MCP) server that integrates with the Cronlytic API to provide seamless cron job management through LLM applications like Claude Desktop.
Final Status: β All 6 phases complete | 88/88 tests passing | Production documentation ready
The Cronlytic MCP Server enables AI agents and LLM applications to:
- π Health Check: Test connectivity and authentication with the Cronlytic API β
- π Job Management: Create, read, update, and delete cron jobs β
- β―οΈ Job Control: Pause, resume, and monitor job execution β
- π Logs & Monitoring: Access execution logs and performance metrics β
- π€ Smart Prompts: 18 comprehensive prompts for guided assistance β
- π Resources: Dynamic job resources and cron templates β
- β‘ Performance: Built-in monitoring and optimization β
π― Final Achievement Summary:
- β Phase 1: Core infrastructure and authentication
- β Phase 2: Basic CRUD operations (13 tests)
- β Phase 3: Advanced job management (22 tests)
- β Phase 4: Resources implementation (14 tests)
- β Phase 5: Prompts & UX (39 tests)
- β Phase 6: Testing & documentation (performance monitoring)
π Key Metrics:
- 88/88 Tests Passing (100% success rate)
- 18 Interactive Prompts (225% of original scope)
- 9 Comprehensive Tools (Full job lifecycle)
- Complete Documentation Suite (8 detailed guides)
- Production Ready (Multi-platform deployment support)
- Python 3.8 or higher
- Cronlytic account with API access
# Clone the repository
git clone https://github.com/Cronlytic/cronlytic-mcp-server.git
cd cronlytic-mcp-server
# Run the setup script (creates venv and installs everything)
./setup_dev_env.sh
# Activate the virtual environment
source venv/bin/activate
# Clone the repository
git clone https://github.com/Cronlytic/cronlytic-mcp-server.git
cd cronlytic-mcp-server
# Create virtual environment
python3 -m venv venv
source venv/bin/activate
# Upgrade pip
pip install --upgrade pip
# Install dependencies
pip install -r requirements.txt
# Install development dependencies (optional)
pip install -r requirements-dev.txt
# Install in development mode
pip install -e .
The server needs your Cronlytic API credentials to function. You can provide these in several ways:
export CRONLYTIC_API_KEY="your_api_key_here"
export CRONLYTIC_USER_ID="your_user_id_here"
Create a configuration file at one of these locations:
./cronlytic_config.json
(current directory)~/.cronlytic/config.json
(user home directory)/etc/cronlytic/config.json
(system-wide)
{
"api_key": "your_cronlytic_api_key_here",
"user_id": "your_cronlytic_user_id_here",
"base_url": "https://api.cronlytic.com/prog",
"timeout": 30,
"max_retries": 3,
"retry_delay": 1.0
}
python -m cronlytic_mcp_server.server --api-key "your_key" --user-id "your_id"
- Log into your Cronlytic dashboard
- Navigate to "API Keys" section
- Click "Generate New API Key"
- Copy your API key and User ID
# Basic usage (reads from environment variables or config file)
python -m cronlytic_mcp_server.server
# With command line arguments
python -m cronlytic_mcp_server.server --api-key "your_key" --user-id "your_id"
# With debug logging
python -m cronlytic_mcp_server.server --debug
# With custom config file
python -m cronlytic_mcp_server.server --config /path/to/config.json
Test connectivity and authentication with the Cronlytic API:
# The health_check tool requires no parameters
# It will test:
# - API connectivity
# - Authentication validity
# - Response times
# - Basic functionality
Example Output:
# Cronlytic API Health Check
**Status:** β
Cronlytic API connection is healthy and working correctly
**Timestamp:** 2025-01-27T10:30:00Z
**Response Time:** 150 ms
## Connection Details
- **Base URL:** https://api.cronlytic.com/prog
- **Connectivity:** β
- **Authentication:** β
## Job Information
- **Job Count:** 3
- **Can List Jobs:** β
## Performance
- **Performance Rating:** Good
## Recommendations
- π‘ Found 3 job(s). All systems appear to be working correctly.
To use with Claude Desktop, add this to your claude_desktop_config.json
:
{
"mcpServers": {
"cronlytic": {
"command": "python",
"args": ["-m", "cronlytic_mcp_server.server"],
"env": {
"CRONLYTIC_API_KEY": "your_api_key_here",
"CRONLYTIC_USER_ID": "your_user_id_here"
}
}
}
}
To run virtual environment of python
{
"mcpServers": {
"cronlytic": {
"command": "python",
"args": ["-m", "src.server"],
"cwd": "PATH/cronlytic-mcp-server",
"env": {
"VIRTUAL_ENV": "PATH/cronlytic-mcp-server/.venv",
"PATH": "PATH/cronlytic-mcp-server/.venv/bin:${PATH}",
"CRONLYTIC_API_KEY": "your_api_key_here",
"CRONLYTIC_USER_ID": "your_user_id_here"
}
}
}
}
cronlytic-mcp-server/
βββ src/
β βββ __init__.py # Package initialization
β βββ server.py # Main MCP server implementation
β βββ cronlytic_client.py # Cronlytic API client wrapper
β βββ tools/ # Tool implementations
β β βββ __init__.py
β β βββ health_check.py # Health check tool
β βββ resources/ # Resource implementations (Phase 4)
β βββ prompts/ # Prompt implementations (Phase 5)
β βββ utils/ # Utility modules
β βββ __init__.py
β βββ auth.py # Authentication handling
β βββ errors.py # Custom error classes
β βββ validation.py # Input validation
βββ tests/ # Test files (Phase 6)
βββ config/
β βββ example_config.json # Example configuration
βββ requirements.txt
βββ pyproject.toml
βββ README.md
# Activate virtual environment (if not already active)
source venv/bin/activate
# Install in development mode (if not already done)
pip install -e .
# Set environment variables for testing
export CRONLYTIC_API_KEY="your_test_key"
export CRONLYTIC_USER_ID="your_test_user_id"
# Run with debug logging
python -m cronlytic_mcp_server.server --debug
# Run validation tests
python validate_phase1.py
# Format code (if you have development dependencies)
black src/
ruff check src/
# Type checking
mypy src/
# Install MCP Inspector
npm install -g @modelcontextprotocol/inspector
# Test the server
mcp-inspector python -m cronlytic_mcp_server.server
The server provides comprehensive error handling:
- Authentication Errors: Clear guidance on credential issues
- Connection Errors: Network and connectivity diagnostics
- Validation Errors: Detailed field-by-field validation messages
- API Errors: Proper error codes and user-friendly messages
- Rate Limiting: Automatic retry with exponential backoff
Structured logging is provided at multiple levels:
# Normal operation
2025-01-27 10:30:00 - cronlytic_mcp_server.server - INFO - Cronlytic MCP Server initialized
# Debug mode
python -m cronlytic_mcp_server.server --debug
create_job
- Create new cron jobslist_jobs
- List all user jobsget_job
- Get specific job detailsupdate_job
- Update existing jobsdelete_job
- Delete jobs permanently
pause_job
- Pause job executionresume_job
- Resume paused jobsget_job_logs
- Retrieve execution logs
- Dynamic job resources
- Cron template library
- Real-time resource updates
- Interactive job creation flows
- Monitoring and troubleshooting guidance
- User experience optimization
- Comprehensive test suite
- Performance optimization
- Complete documentation
This project follows a structured development approach with clearly defined phases. Each phase builds upon the previous one to ensure stability and maintainability.
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests (Phase 6)
- Submit a pull request
MIT License - see LICENSE file for details.
- Documentation: See
docs/
directory for detailed specifications - Issues: Report bugs and feature requests on GitHub
- API Reference: Check
docs/cronlytic-API-specification.md
- Cronlytic - The cron job monitoring service
- Model Context Protocol - The open protocol for AI integration
- Claude Desktop - AI assistant with MCP support
Current Version: 0.1.0 Last Updated: Jun 2025