@softure-ai/mcp-access 0.4.0 → 0.6.0

package/src/server/tool-list-session.ts

@@ -0,0 +1,103 @@
+// Sessions tied to the tool list version (#1055). A hosted client keeps its cached `tools/list` for as long as its
+// connection lives, even after a release changed a tool, and the endpoint has no channel to send
+// `notifications/tools/list_changed`. So the endpoint answers `initialize` with an `Mcp-Session-Id` that carries the
+// tool list version of the identity's access level, and a later request whose session carries another version gets
+// `404 Not Found`: Streamable HTTP defines that as "start a new session", so the client initializes again and lists
+// the tools again. Nothing is stored: the id itself holds the version, so any instance can check it.
+import { randomBytes } from "node:crypto";
+
+/** The header that carries the session id, both ways. */
+export const MCP_SESSION_ID_HEADER = "mcp-session-id";
+
+/** Random bytes after the version, as hex. */
+const RANDOM_BYTES = 16;
+const SESSION_ID_PATTERN = /^([A-Za-z0-9_-]+)\.[0-9a-f]+$/;
+const SSE_DATA_PREFIX = "data: ";
+
+/** A new session id for the version: `<base64url(version)>.<32 hex>`, visible ASCII whatever the version holds. */
+export function createToolListSessionId(toolListVersion: string): string {
+  return `${Buffer.from(toolListVersion, "utf8").toString("base64url")}.${randomBytes(RANDOM_BYTES).toString("hex")}`;
+}
+
+/** The tool list version a session id carries, or `null` when the id is not one the endpoint issues. */
+export function readToolListSessionVersion(sessionId: string): string | null {
+  const match = SESSION_ID_PATTERN.exec(sessionId);
+  if (match?.[1] === undefined) return null;
+  return Buffer.from(match[1], "base64url").toString("utf8");
+}
+
+/** Whether a request in this session may be served: its version is the current one. */
+export function isToolListSessionCurrent(sessionId: string, toolListVersion: string): boolean {
+  return readToolListSessionVersion(sessionId) === toolListVersion;
+}
+
+/** The answer to a request in a session from another tool list version: the client starts a new session. */
+export function createSessionRenewalResponse(): Response {
+  return Response.json(
+    { jsonrpc: "2.0", error: { code: -32001, message: "Session not found: the tool list changed, initialize again" }, id: null },
+    { status: 404, headers: { "cache-control": "no-store" } },
+  );
+}
+
+/**
+ * Whether the request is a JSON-RPC `initialize`: a POST without a session id whose JSON body asks for it. The body
+ * is read from a clone, and a body over `maxBytes` is not read (the SDK refuses it with 413 anyway).
+ */
+export async function isInitializeRequest(request: Request, maxBytes: number): Promise<boolean> {
+  if (request.method !== "POST" || request.headers.has(MCP_SESSION_ID_HEADER)) return false;
+  const length = Number(request.headers.get("content-length") ?? "0");
+  if (!Number.isFinite(length) || length > maxBytes) return false;
+  let body: unknown;
+  try {
+    const text = await request.clone().text();
+    if (text.length > maxBytes) return false;
+    body = JSON.parse(text);
+  } catch {
+    // Not JSON: the SDK answers the parse error itself.
+    return false;
+  }
+  return typeof body === "object" && body !== null && !Array.isArray(body) && (body as { method?: unknown }).method === "initialize";
+}
+
+/**
+ * The `initialize` answer with `capabilities.tools.listChanged: false`, since no answer of the endpoint ever carries
+ * the notification, and with the session id when there is one. The body keeps its format (JSON or one SSE event);
+ * an answer that is not a successful `InitializeResult` is returned as it is.
+ */
+export async function rewriteInitializeAnswer(response: Response, sessionId: string | null): Promise<Response> {
+  if (response.status !== 200) return response;
+  const text = await response.text();
+  const isEventStream = (response.headers.get("content-type") ?? "").includes("text/event-stream");
+  const lines = text.split("\n");
+  const dataIndex = isEventStream ? lines.findIndex((line) => line.startsWith(SSE_DATA_PREFIX)) : -1;
+  const json = isEventStream ? (dataIndex === -1 ? null : (lines[dataIndex] ?? "").slice(SSE_DATA_PREFIX.length)) : text;
+
+  const answer = parseInitializeAnswer(json);
+  const headers = new Headers(response.headers);
+  // The body changes length, so the old one would be wrong.
+  headers.delete("content-length");
+  const tools = answer?.result?.capabilities?.tools;
+  if (answer === null || answer.result?.protocolVersion === undefined) {
+    return new Response(text, { status: response.status, statusText: response.statusText, headers });
+  }
+  if (tools !== undefined && tools !== null && typeof tools === "object") tools.listChanged = false;
+  if (sessionId !== null) headers.set(MCP_SESSION_ID_HEADER, sessionId);
+
+  const rewritten = JSON.stringify(answer);
+  if (isEventStream) lines[dataIndex] = `${SSE_DATA_PREFIX}${rewritten}`;
+  return new Response(isEventStream ? lines.join("\n") : rewritten, { status: response.status, statusText: response.statusText, headers });
+}
+
+/** The answer as JSON, or `null` when there is none or it is not JSON (the SDK's own error text). */
+function parseInitializeAnswer(json: string | null): InitializeAnswer | null {
+  if (json === null) return null;
+  try {
+    return JSON.parse(json) as InitializeAnswer;
+  } catch {
+    return null;
+  }
+}
+
+interface InitializeAnswer {
+  result?: { protocolVersion?: unknown; capabilities?: { tools?: { listChanged?: boolean } | null } };
+}

package/src/testing/index.ts

@@ -6,3 +6,4 @@ export {
   type ServedToolLists,
   type ToolCatalogDifferences,
 } from "./catalog.js";
+export { expectToolListSessionRenewed } from "./sessions.js";

package/src/testing/sessions.ts

@@ -0,0 +1,41 @@
+// Sessions tied to the tool list version (#1055), checked on the app's factories: a release that changes a tool must
+// renew the sessions opened before it, or a connected client keeps the old schemas. Framework-free: it throws.
+import type { McpServerIdentity } from "../contract.js";
+import type { McpServerFactory, VersionedMcpServerFactory } from "../server/endpoint.js";
+import { createToolListSessionId, isToolListSessionCurrent } from "../server/tool-list-session.js";
+import { fingerprintToolList, listServedTools } from "../server/tool-list.js";
+
+const READER: McpServerIdentity = { userId: "00000000-0000-4000-8000-000000000001", canWrite: false, tokenId: "session-check" };
+const WRITER: McpServerIdentity = { ...READER, canWrite: true };
+const LEVELS = [
+  ["read", READER],
+  ["write", WRITER],
+] as const;
+
+/**
+ * Throws unless a session opened under `before` (the previous release's factory) is renewed under `after` for every
+ * access level whose served tool list changed, and kept for every level whose list did not. A pair where no level
+ * changed throws too: the check would prove nothing.
+ */
+export async function expectToolListSessionRenewed(before: McpServerFactory, after: McpServerFactory): Promise<void> {
+  const problems: string[] = [];
+  const unchanged: string[] = [];
+  for (const [level, identity] of LEVELS) {
+    const sessionId = createToolListSessionId(await readVersion(before, identity));
+    const isCurrent = isToolListSessionCurrent(sessionId, await readVersion(after, identity));
+    const hasChanged = fingerprintToolList(await listServedTools(() => before(identity))) !== fingerprintToolList(await listServedTools(() => after(identity)));
+    if (!hasChanged) unchanged.push(level);
+    if (hasChanged && isCurrent) problems.push(`the ${level} tool list changed but a session opened before is kept`);
+    if (!hasChanged && !isCurrent) problems.push(`the ${level} tool list did not change but a session opened before is renewed`);
+  }
+  if (unchanged.length === LEVELS.length) problems.push(`the tool list did not change for any access level (${unchanged.join(", ")})`);
+  if (problems.length > 0) throw new Error(`@softure-ai/mcp-access: sessions do not follow the tool list: ${problems.join("; ")}`);
+}
+
+async function readVersion(factory: McpServerFactory, identity: McpServerIdentity): Promise<string> {
+  const reader = (factory as Partial<VersionedMcpServerFactory>).toolListVersion;
+  if (typeof reader !== "function") {
+    throw new Error("@softure-ai/mcp-access: the factory has no toolListVersion; build it with createMcpServerFactory or pass toolListVersion to createMcpEndpoint");
+  }
+  return reader(identity);
+}