Skip to content

Commit a3ecfee

Browse files
committed
Update documentation for graceful degradation and /health endpoint
- Add /health endpoint to docs/endpoints.md for MCP server - Document degraded mode behavior in Common Issues section - Update OAuth metadata endpoint to mention 503 responses
1 parent 7b7aa51 commit a3ecfee

2 files changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -476,6 +476,17 @@ The script:
476476
- Google/GitHub OAuth
477477
- The mock IDP creates random user IDs for testing multi-user scenarios
478478

479+
### "Authentication service unavailable" (HTTP 503)
480+
- **Cause**: Auth server is not running or not reachable
481+
- **What happens**: MCP server runs in degraded mode
482+
- Splash page accessible with warning banner
483+
- Health endpoint shows degraded status: `curl http://localhost:3232/health`
484+
- Protected MCP endpoints return 503 with helpful error message
485+
- **Solution**:
486+
- Start the auth server: `npm run dev` (starts both servers)
487+
- Or start manually: `cd auth-server && npm run dev`
488+
- Restart the MCP server to retry connection
489+
479490
### "Authentication flow fails"
480491
- **Cause**: Misconfiguration or servers not communicating
481492
- **Solution**:

docs/endpoints.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@ Local simulation of upstream IDP (would be external in production):
4242
MCP resource server that implements the Model Context Protocol with delegated authentication.
4343

4444
### OAuth Metadata (Read-Only)
45-
Provided by `mcpAuthMetadataRouter`:
4645

4746
- `GET /.well-known/oauth-authorization-server` - Returns metadata pointing to external auth server
4847
- Tells clients to use auth server at :3001
48+
- Returns 503 if auth server is unavailable (degraded mode)
4949
- Read-only - no token issuance happens here
5050

5151
### MCP Resource Endpoints
@@ -61,8 +61,13 @@ Provided by `mcpAuthMetadataRouter`:
6161

6262
All MCP endpoints require `Authorization: Bearer <token>` header. Tokens are validated by calling the auth server's `/introspect` endpoint.
6363

64+
### Utility Endpoints
65+
- `GET /health` - Health check endpoint
66+
- Returns status: `healthy` (auth available) or `degraded` (auth unavailable)
67+
- Shows operational status of MCP, auth, and Redis services
68+
6469
### Static Assets
65-
- `GET /` - Splash page (HTML)
70+
- `GET /` - Splash page (HTML with degraded mode warning if auth unavailable)
6671
- `GET /mcp-logo.png` - MCP logo
6772
- `GET /styles.css` - Stylesheet
6873

0 commit comments

Comments
 (0)