Planned integration for DHIS2 Android SDK, providing tools for mobile project setup, offline-first architecture patterns, GPS and media capture support, and synchronization strategies for health data collection apps.
DHIS2 MCP Server
🚀 Production Ready: A comprehensive Model Context Protocol (MCP) server for DHIS2 development and management, providing 60+ tools for complete DHIS2 Web API coverage, app development, and community-driven debugging solutions.
✨ Features
🏗️ Complete DHIS2 Web API Coverage
- Aggregate Data Model: Data elements, data sets, categories, validation rules
- Event/Tracker Data Model: Programs, tracked entities, events, enrollments
- Analytics & Reporting: Dashboards, visualizations, event analytics
- Bulk Operations: Mass data import/export with validation
- System Management: Connection handling, system info, statistics
🛡️ Production Grade
- Type Safety: Comprehensive TypeScript interfaces with strict mode
- Error Handling: Robust error management with meaningful messages
- Testing: 26 automated tests ensuring reliability
- Code Quality: ESLint validation and best practices
- Build Pipeline: Complete development workflow
🔧 Developer Experience
- 60+ MCP Tools: Complete DHIS2 development lifecycle coverage
- Web App Platform: Full scaffolding and debugging toolkit
- Community Solutions: Real-world problem solving based on DHIS2 community issues
- Detailed Schemas: Rich input validation and documentation
- Easy Setup: Simple npm commands for all operations
- Interactive: Perfect for API exploration, development, and troubleshooting
🚀 Quick Start
Prerequisites
- Node.js 18+
- Access to a DHIS2 instance (demo, local, or production)
Installation
First Connection
Once the MCP server is running, use the dhis2_configure
tool to connect:
📖 Usage Examples
Web App Development (Phase 2)
UI Library Integration (Phase 4)
Advanced options
Android UI Patterns (Phase 4)
Advanced options
Data Management
Tracker Programs
Analytics & Reporting
🛠️ Development
Available Commands
Project Structure
🛠️ Development & Debugging Tools
CORS & Authentication Issues
- CORS Diagnosis: Identify and fix cross-origin resource sharing problems
- Browser Configuration: Chrome, Firefox, Safari-specific solutions
- Authentication Debug: Login failures, session timeouts, cookie problems
- Proxy Setup: Development proxy configuration for all build tools
Build & Performance Issues
- Build Troubleshooting: webpack, Vite, d2 CLI, App Platform issues
- Performance Analysis: Bundle size, memory leaks, API bottlenecks
- Migration Support: Automated d2 library → App Platform migration
- Environment Validation: Complete development environment health checks
Web App Scaffolding
- Project Initialization: Full DHIS2 app setup with templates
- Configuration Generation: d2.config.js, manifest.webapp, build systems
- Component Library: UI components using @dhis2/ui with data integration
- Testing Setup: Jest, Cypress, Playwright configuration
🎯 Supported DHIS2 Operations
Aggregate Data Model
- ✅ Data Elements: Full CRUD with 15+ value types
- ✅ Data Sets: Period types, org units, sections
- ✅ Categories: Options, combinations, disaggregation
- ✅ Data Values: Bulk operations, validation, audit
- ✅ Validation Rules: Creation, execution, results
- ✅ Organisation Units: Groups, hierarchies, coordinates
Event/Tracker Data Model
- ✅ Programs: WITH_REGISTRATION, WITHOUT_REGISTRATION
- ✅ Tracked Entity Types: Attributes, validation, patterns
- ✅ Program Stages: Data elements, sections, rules
- ✅ Program Rules: 10+ action types, expressions
- ✅ Tracked Entity Instances: Registration, relationships
- ✅ Events: Data capture, coordinates, status management
- ✅ Enrollments: Program workflows, dates, transfers
Analytics & Reporting
- ✅ Event Analytics: Advanced querying, dimensions
- ✅ Enrollment Analytics: Program-based insights
- ✅ Dashboards: Items, layouts, visualizations
- ✅ Visualizations: 15+ chart types, pivot tables
- ✅ Reports: Generation, templates, parameters
- ✅ Data Statistics: System overview, metrics
🧪 Testing
The project includes comprehensive test coverage:
- Unit Tests: Core functionality validation
- Integration Tests: DHIS2 client operations
- Tool Schema Tests: Input validation and schemas
- Error Handling Tests: Robust error scenarios
📝 Configuration
Environment Variables
DHIS2 Version Compatibility
- ✅ DHIS2 2.38+: Fully supported
- ✅ DHIS2 2.39+: All features available
- ✅ DHIS2 2.40+: Latest features supported
🤝 Use Cases
1. Health Information System Setup
Complete metadata configuration for new DHIS2 implementations.
2. Data Migration & Integration
Bulk data operations between DHIS2 instances or external systems.
3. Quality Assurance & Validation
Automated data validation and quality checking workflows.
4. Learning & Training
Interactive DHIS2 API exploration and concept learning.
5. Development & Testing
API testing, integration development, and debugging support.
6. System Monitoring
Analytics automation and system health monitoring.
📚 Documentation
- Implementation Plan: IMPLEMENTATION_PLAN.md - Detailed project roadmap
- Development Guide: CLAUDE.md - Development instructions and patterns
- API Reference: Tool schemas provide comprehensive parameter documentation
- DHIS2 Documentation: docs.dhis2.org
🔄 Roadmap
✅ Phase 1: Web API Foundation (COMPLETED)
- Complete DHIS2 Web API coverage
- Production-ready MCP server
- Comprehensive testing and validation
✅ Phase 2: Web App Platform Integration (COMPLETED)
- ✅ DHIS2 app scaffolding and initialization tools
- ✅ App Runtime integration patterns and examples
- ✅ Development environment setup and configuration
- ✅ Authentication and security patterns
- ✅ Build system configuration (d2.config.js, webpack, vite)
- ✅ UI component generation with @dhis2/ui integration
- ✅ Testing framework setup (Jest, Cypress, Playwright)
- ✅ DataStore operations and namespace management
✅ Phase 2+: Community-Driven Debugging Tools (COMPLETED)
- ✅ CORS Issues Diagnosis: Browser-specific solutions for cross-origin problems
- ✅ Authentication Debugging: Login failures, session management, cookie issues
- ✅ Proxy Configuration: Local development proxy setup for all build tools
- ✅ Build Issue Resolution: d2 CLI migration, dependency conflicts, bundling problems
- ✅ Performance Optimization: Bundle analysis, memory leaks, API bottlenecks
- ✅ Environment Validation: Development environment health checks
- ✅ Migration Assistant: Automated guidance for d2 library → App Platform transitions
🔮 Phase 3: Android SDK Integration
- Mobile project setup tools
- Offline-first architecture patterns
- GPS and media capture support
- Synchronization strategies
🎨 Phase 4: UI Library Integration (IN PROGRESS)
- @dhis2/ui component integration (forms, data display, navigation & layout)
- Design system patterns (palette, typography, spacing, dark mode)
- Responsive layout tools
- Mobile UI components (Android Compose: form, list adapter, navigation drawer, bottom sheet)
🏆 Project Status
🚀 Production Ready - Phase 1 & 2 Complete
Metric | Achievement |
---|---|
MCP Tools | 60+ comprehensive tools |
DHIS2 Endpoints | 30+ API endpoints covered |
Web App Platform | Complete integration toolkit |
Debugging Tools | Community-driven troubleshooting |
TypeScript Interfaces | 50+ type definitions |
Test Coverage | 26 automated tests |
Code Quality | ESLint + strict TypeScript |
🤝 Contributing
We welcome contributions! Please see our contributing guidelines:
- Fork the repository
- Create a feature branch
- Make your changes with tests
- Ensure all tests pass:
npm run test
- Submit a pull request
Development Setup
📄 License
MIT License - see LICENSE file for details.
🙏 Acknowledgments
- DHIS2 Community: For the amazing health information platform
- Model Context Protocol: For the innovative AI-human collaboration framework
- TypeScript Team: For excellent type safety tools
- Open Source Community: For the foundational tools and libraries
🆘 Support
- Issues: GitHub Issues
- DHIS2 Community: community.dhis2.org
- Documentation: docs.dhis2.org
Made with ❤️ for the global health community
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Enables comprehensive interaction with DHIS2 health information systems through 40+ tools covering complete Web API functionality. Supports data management, tracker programs, analytics, and bulk operations for DHIS2 development and administration.
- ✨ Features
- 🚀 Quick Start
- 📖 Usage Examples
- 🛠️ Development
- 🛠️ Development & Debugging Tools
- 🎯 Supported DHIS2 Operations
- 🧪 Testing
- 📝 Configuration
- 🤝 Use Cases
- 📚 Documentation
- 🔄 Roadmap
- 🏆 Project Status
- 🤝 Contributing
- 📄 License
- 🙏 Acknowledgments
- 🆘 Support
Related Resources
Related MCP Servers
- AsecurityFlicenseAqualityFacilitates AI session handoffs and next steps tracking through project-based organization, supporting task prioritization and seamless workflow management.Last updated -87JavaScript
- AsecurityAlicenseAqualityProvides tools to interact with the HireBase Job API, enabling users to search for jobs using various criteria and retrieve detailed job information through natural language.Last updated -27PythonMIT License
- -securityFlicense-qualityThis server enables interacting with the National Digital Health Mission's Health Information User (HIU) API, allowing agents to access and manage health information through the Multi-Agent Conversation Protocol.Last updated -Python
- -securityAlicense-qualityProvides tools for AI assistants to interact with Airtable databases, enabling CRUD operations on Airtable bases and tables.Last updated -TypeScriptMIT License