API Documentation
Health Check
Check the health and status of the Financial MCP Server
GET
Verify that the Financial MCP Server is running properly and check the status of all integrated services.
Response
Overall health status: “healthy”, “degraded”, or “unhealthy”
Current server timestamp
Server version information
Server uptime in seconds
Status of individual services
Summary of available tools
Environment information
Status Codes
Overall Status
- healthy: All services operational
- degraded: Some services experiencing issues
- unhealthy: Critical services down
Service Status
- operational: Service working normally
- degraded: Service slow or intermittent issues
- down: Service unavailable
Use Cases
- Monitoring: Automated health checks
- Troubleshooting: Diagnose service issues
- Load Balancing: Route traffic to healthy instances
- Alerting: Set up monitoring alerts
- Maintenance: Check status before deployments
Monitoring Best Practices
- Regular Checks: Poll every 30-60 seconds
- Alert Thresholds: Alert on “degraded” or “unhealthy”
- Response Time: Monitor service response times
- Uptime Tracking: Track availability metrics
- Dependency Monitoring: Watch external service status
Notes
- No authentication required for health checks
- Endpoint designed for high-frequency monitoring
- Includes both internal and external service dependencies
- Response times are rolling averages over the last 5 minutes
- Memory usage updated every minute