@ultimatelemon-eu/mcp-http 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -9
- package/dist/server.d.ts +1 -1
- package/dist/server.js +2 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -35,15 +35,15 @@ process.once('SIGTERM', () => {
|
|
|
35
35
|
|
|
36
36
|
## Options
|
|
37
37
|
|
|
38
|
-
| Option | Default | Does
|
|
39
|
-
| ----------------- | ----------- |
|
|
40
|
-
| `createMcpServer` | required | Returns a new `McpServer` per request, given `{ apiKey }`
|
|
41
|
-
| `port` | required | `0` picks a free port; read it back from `.port`
|
|
42
|
-
| `host` | `'0.0.0.0'` | `'127.0.0.1'` keeps it local
|
|
43
|
-
| `basePath` | `''` | Also serve `<basePath>/mcp
|
|
44
|
-
| `health` | always ok | Return `false` for a 503 on `/healthz`
|
|
45
|
-
| `apiKey` | off | Require the caller's key; `hint` is added to the 401 message
|
|
46
|
-
| `logger` | silent | Anything with `error(obj, msg)`, such as pino
|
|
38
|
+
| Option | Default | Does |
|
|
39
|
+
| ----------------- | ----------- | ----------------------------------------------------------------------------- |
|
|
40
|
+
| `createMcpServer` | required | Returns a new `McpServer` per request, given `{ apiKey }` |
|
|
41
|
+
| `port` | required | `0` picks a free port; read it back from `.port` |
|
|
42
|
+
| `host` | `'0.0.0.0'` | `'127.0.0.1'` keeps it local |
|
|
43
|
+
| `basePath` | `''` | Also serve MCP on `<basePath>` and `<basePath>/mcp`, and `<basePath>/healthz` |
|
|
44
|
+
| `health` | always ok | Return `false` for a 503 on `/healthz` |
|
|
45
|
+
| `apiKey` | off | Require the caller's key; `hint` is added to the 401 message |
|
|
46
|
+
| `logger` | silent | Anything with `error(obj, msg)`, such as pino |
|
|
47
47
|
|
|
48
48
|
It returns `{ url, port, close() }`.
|
|
49
49
|
|
package/dist/server.d.ts
CHANGED
|
@@ -17,7 +17,7 @@ export interface McpHttpOptions {
|
|
|
17
17
|
port: number;
|
|
18
18
|
/** Interface to listen on. Default `0.0.0.0`. */
|
|
19
19
|
host?: string;
|
|
20
|
-
/** Prefix a proxy leaves on the path, e.g. `/ns`.
|
|
20
|
+
/** Prefix a proxy leaves on the path, e.g. `/ns`. MCP is served on `/mcp`, `<basePath>/mcp` and `<basePath>` itself. */
|
|
21
21
|
basePath?: string;
|
|
22
22
|
/** Readiness for `/healthz`; return false for a 503. Default: always ready. */
|
|
23
23
|
health?: () => boolean | Promise<boolean>;
|
package/dist/server.js
CHANGED
|
@@ -77,6 +77,8 @@ export async function startMcpHttpServer(options) {
|
|
|
77
77
|
const logger = options.logger ?? silent;
|
|
78
78
|
const base = normalizeBasePath(options.basePath);
|
|
79
79
|
const mcpPaths = new Set([`${base}/mcp`, '/mcp']);
|
|
80
|
+
if (base)
|
|
81
|
+
mcpPaths.add(base);
|
|
80
82
|
const healthPaths = new Set([`${base}/healthz`, '/healthz']);
|
|
81
83
|
// The key travels as pass-through authInfo, the SDK's channel from the
|
|
82
84
|
// HTTP request to the per-request factory.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ultimatelemon-eu/mcp-http",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.1.0",
|
|
4
4
|
"description": "Run an MCP server over stateless Streamable HTTP: /mcp, /healthz, a base path for proxies, the caller's own API key per request, and errors that never leak a stack trace.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|