@ivotoby/openapi-mcp-server 1.9.2 → 1.10.0

package/README.md

@@ -297,6 +297,48 @@ The HTTP transport allows the MCP server to be accessed over HTTP, enabling web
 
 **When to use**: When you need to expose the MCP server to web clients or systems that communicate over HTTP rather than stdio.
 
+### Health Check Endpoint
+
+When using HTTP transport, a health check endpoint is available at `/health` for monitoring and service discovery:
+
+```bash
+# Check server health
+curl http://localhost:3000/health
+
+# Response:
+# {
+#   "status": "healthy",
+#   "activeSessions": 2,
+#   "uptime": 3600
+# }
+```
+
+**Health Response Fields:**
+- `status`: Always returns "healthy" when server is running
+- `activeSessions`: Number of active MCP sessions
+- `uptime`: Server uptime in seconds
+
+**Key Features:**
+- No authentication required
+- Works with any HTTP method (GET, POST, etc.)
+- Ideal for load balancers, Kubernetes probes, and monitoring systems
+
+**Integration Examples:**
+
+```yaml
+# Kubernetes liveness probe
+livenessProbe:
+  httpGet:
+    path: /health
+    port: 3000
+  initialDelaySeconds: 3
+  periodSeconds: 10
+
+# Docker healthcheck
+HEALTHCHECK --interval=30s --timeout=3s \
+  CMD curl -f http://localhost:3000/health || exit 1
+```
+
 ## Security Considerations
 
 - The HTTP transport validates Origin headers to prevent DNS rebinding attacks

package/dist/bundle.js

@@ -24000,7 +24000,6 @@ import {
 import * as http2 from "http";
 import { randomUUID } from "crypto";
 var StreamableHttpServerTransport = class {
-  // Maps request IDs to session IDs
   /**
    * Initialize a new StreamableHttpServerTransport
    *
@@ -24017,9 +24016,12 @@ var StreamableHttpServerTransport = class {
   server;
   sessions = /* @__PURE__ */ new Map();
   started = false;
+  startTime = Date.now();
   maxBodySize = 4 * 1024 * 1024;
   // 4MB max request size
   requestSessionMap = /* @__PURE__ */ new Map();
+  // Maps request IDs to session IDs
+  healthCheckPath = "/health";
   /**
    * Callback when message is received
    */
@@ -24163,10 +24165,28 @@ var StreamableHttpServerTransport = class {
       }
     }
   }
+  /**
+   * Handle health check request
+   */
+  handleHealthCheck(_req, res) {
+    const uptime = Math.floor((Date.now() - this.startTime) / 1e3);
+    const healthResponse = {
+      status: "healthy",
+      activeSessions: this.sessions.size,
+      uptime
+    };
+    res.setHeader("Content-Type", "application/json");
+    res.writeHead(200);
+    res.end(JSON.stringify(healthResponse));
+  }
   /**
    * Handle HTTP request
    */
   handleRequest(req, res) {
+    if (req.url === this.healthCheckPath) {
+      this.handleHealthCheck(req, res);
+      return;
+    }
     if (req.url !== this.endpointPath) {
       res.writeHead(404);
       res.end();

package/dist/cli.js

@@ -24000,7 +24000,6 @@ import {
 import * as http2 from "http";
 import { randomUUID } from "crypto";
 var StreamableHttpServerTransport = class {
-  // Maps request IDs to session IDs
   /**
    * Initialize a new StreamableHttpServerTransport
    *
@@ -24017,9 +24016,12 @@ var StreamableHttpServerTransport = class {
   server;
   sessions = /* @__PURE__ */ new Map();
   started = false;
+  startTime = Date.now();
   maxBodySize = 4 * 1024 * 1024;
   // 4MB max request size
   requestSessionMap = /* @__PURE__ */ new Map();
+  // Maps request IDs to session IDs
+  healthCheckPath = "/health";
   /**
    * Callback when message is received
    */
@@ -24163,10 +24165,28 @@ var StreamableHttpServerTransport = class {
       }
     }
   }
+  /**
+   * Handle health check request
+   */
+  handleHealthCheck(_req, res) {
+    const uptime = Math.floor((Date.now() - this.startTime) / 1e3);
+    const healthResponse = {
+      status: "healthy",
+      activeSessions: this.sessions.size,
+      uptime
+    };
+    res.setHeader("Content-Type", "application/json");
+    res.writeHead(200);
+    res.end(JSON.stringify(healthResponse));
+  }
   /**
    * Handle HTTP request
    */
   handleRequest(req, res) {
+    if (req.url === this.healthCheckPath) {
+      this.handleHealthCheck(req, res);
+      return;
+    }
     if (req.url !== this.endpointPath) {
       res.writeHead(404);
       res.end();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ivotoby/openapi-mcp-server",
-  "version": "1.9.2",
+  "version": "1.10.0",
   "description": "An MCP server that exposes OpenAPI endpoints as resources",
   "license": "MIT",
   "type": "module",
@@ -9,9 +9,12 @@
     "type": "git",
     "url": "https://github.com/ivo-toby/mcp-openapi-server"
   },
-  "bin": "./bin/mcp-server.js",
+  "bin": {
+    "openapi-mcp-server": "./bin/mcp-server.js"
+  },
   "files": [
-    "dist"
+    "dist",
+    "bin"
   ],
   "scripts": {
     "build": "node build.js && chmod +x bin/mcp-server.js",