feat: add health-check in documentation and enrich response [MCP-517]#1267
Open
gusanthiago wants to merge 2 commits into
Open
feat: add health-check in documentation and enrich response [MCP-517]#1267gusanthiago wants to merge 2 commits into
gusanthiago wants to merge 2 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proposed Changes
Closes #1223.
The README never documented that the health check path is
/health, so I added a"Monitoring Server (Health Check & Metrics)" section covering:
health-check→/healthandmetrics→/metricsmappings.--monitoringServerFeatures health-check,metricsform.monitoringServerHostandmonitoringServerPortare set.I also enriched the
/healthresponse. It still returnsstatus: "ok"(nothing breaks),but now includes
version,uptimeSeconds, andtimestamp, and setsCache-Control: no-store:{ "status": "ok", "version": "1.13.0", "uptimeSeconds": 42, "timestamp": "2026-06-20T12:00:00.000Z" }I didn't add a DB/readiness check — connections are per-session, so there's no single
"is the DB up" answer without a bigger change. Happy to drop the response changes if you'd
prefer this stay docs-only.
Testing
monitoringServer.test.tsfor the new fields and header (9/9 passing).Checklist