@emseepea/create-progress-streaming-server 0.0.13 → 0.0.18

package/README.md

@@ -17,12 +17,37 @@ npm init @emseepea/progress-streaming-server -- my-server
 
 <!-- generated-project-readme -->
 
+## Choose Open or Protected Access
+
+Start open when the catalogue and operations are public.
+
+To protect this template, pass both options to the app factory:
+
+- `access: { access: "protected", requiredScopes: ["peas:read"] }`
+- an `authentication` adapter
+
+Keep `authentication.discovery` as `"public"` unless capability names or
+schemas are sensitive. Use `"protected"` only when each principal should see a
+permission-filtered catalogue. OAuth metadata remains public in both modes.
+
+## Add Observability
+
+The same factory accepts `observability`.
+
+- Use `structuredLogging` for safe structured events.
+- Use `openTelemetry` for traces and metrics.
+
+Adapters receive only redacted framework events. They never receive request
+bodies, arguments, results, tokens, provider claims, or raw errors. See the
+[server API](https://github.com/emseepea/emseepea/tree/main/packages/framework#authentication-and-observability) for the complete configuration.
+
 ## Streaming Progress Example
 
 Choose this example when a tool takes long enough that people benefit from
 seeing progress before the final answer.
 
-The public tool reports progress during its request. A client can ask for
+The tool reports progress during its request. It can use the public access shown
+in the template or the protected access described above. A client can ask for
 server-sent events (SSE), which carry progress over the same `POST` request.
 Without that request, the tool returns one JSON response when it finishes.
 
@@ -39,11 +64,18 @@ npm start
 The server listens on `http://127.0.0.1:3000/mcp` by default. Set `PORT` to
 choose another port. This example starts locally and does not configure a proxy.
 
-To adapt it for a public server, see
+To adapt it for a deployed server, see
 [Use Progress Behind a Proxy](https://github.com/emseepea/emseepea/blob/main/packages/framework/README.md#use-progress-behind-a-proxy).
 It does not add saved sessions, replay, subscriptions, or recovery after
 reconnecting.
 
+## Add Feedback
+
+Install `@emseepea/feedback` when this server needs a detailed one-way
+observation or a durable support conversation. Pass its tools through the
+application factory's `additionalTools` option. Choose PostgreSQL, Firestore,
+GitHub Issues, or Zendesk in the [feedback guide](../../packages/feedback/README.md).
+
 ## Check This Example
 
 [Ordinary tests](test/) live in `test/`.

package/initializer-dist/template/README.md

@@ -1,9 +1,34 @@
-# Streaming Progress Example
+# Choose Open or Protected Access
+
+Start open when the catalogue and operations are public.
+
+To protect this template, pass both options to the app factory:
+
+- `access: { access: "protected", requiredScopes: ["peas:read"] }`
+- an `authentication` adapter
+
+Keep `authentication.discovery` as `"public"` unless capability names or
+schemas are sensitive. Use `"protected"` only when each principal should see a
+permission-filtered catalogue. OAuth metadata remains public in both modes.
+
+## Add Observability
+
+The same factory accepts `observability`.
+
+- Use `structuredLogging` for safe structured events.
+- Use `openTelemetry` for traces and metrics.
+
+Adapters receive only redacted framework events. They never receive request
+bodies, arguments, results, tokens, provider claims, or raw errors. See the
+[server API](https://github.com/emseepea/emseepea/tree/main/packages/framework#authentication-and-observability) for the complete configuration.
+
+## Streaming Progress Example
 
 Choose this example when a tool takes long enough that people benefit from
 seeing progress before the final answer.
 
-The public tool reports progress during its request. A client can ask for
+The tool reports progress during its request. It can use the public access shown
+in the template or the protected access described above. A client can ask for
 server-sent events (SSE), which carry progress over the same `POST` request.
 Without that request, the tool returns one JSON response when it finishes.
 
@@ -20,11 +45,18 @@ npm start
 The server listens on `http://127.0.0.1:3000/mcp` by default. Set `PORT` to
 choose another port. This example starts locally and does not configure a proxy.
 
-To adapt it for a public server, see
+To adapt it for a deployed server, see
 [Use Progress Behind a Proxy](https://github.com/emseepea/emseepea/blob/main/packages/framework/README.md#use-progress-behind-a-proxy).
 It does not add saved sessions, replay, subscriptions, or recovery after
 reconnecting.
 
+## Add Feedback
+
+Install `@emseepea/feedback` when this server needs a detailed one-way
+observation or a durable support conversation. Pass its tools through the
+application factory's `additionalTools` option. Choose PostgreSQL, Firestore,
+GitHub Issues, or Zendesk in the [feedback guide](../../packages/feedback/README.md).
+
 ## Check This Example
 
 [Ordinary tests](test/) live in `test/`.

package/initializer-dist/template/eval/meaning.test.mjs

@@ -1,15 +1,23 @@
 import test from "node:test";
 import {
   assertNoToolCalls,
+  assertNoNegativeFeedback,
   assertResponseContains,
   assertResponseMeaning,
-  assertToolCalls,
+  assertToolCallsWithOptionalFeedback,
   createConversation,
 } from "@emseepea/testing/semantic";
 
+const server = new URL(import.meta.resolve("@emseepea/feedback/testing-server"));
+const environment = {
+  EMSEEPEA_EVAL_APP_MODULE: new URL("../dist/app.js", import.meta.url).href,
+  EMSEEPEA_EVAL_APP_FACTORY: "createProgressStreamingServer",
+};
+
 test("keeps progress stages distinct from the completed result", async (t) => {
   const chat = await createConversation(t, {
-    server: new URL("../dist/server.js", import.meta.url),
+    server,
+    environment,
   });
 
   // The judge checks the important progress-versus-result distinction once.
@@ -18,7 +26,7 @@ test("keeps progress stages distinct from the completed result", async (t) => {
     "Run the sample-tray pea germination trial. List its progress stages and final result.",
   );
 
-  assertToolCalls(response, [{
+  await assertToolCallsWithOptionalFeedback(response, [{
     name: "run-germination-trial",
     arguments: { tray: "sample-tray" },
   }]);
@@ -34,4 +42,5 @@ test("keeps progress stages distinct from the completed result", async (t) => {
   );
   assertNoToolCalls(followUp);
   assertResponseContains(followUp, "sow");
+  assertNoNegativeFeedback(response, followUp);
 });

package/initializer-dist/template/package.json

@@ -14,7 +14,9 @@
     "lint": "oxlint src test eval"
   },
   "devDependencies": {
-    "@emseepea/testing": "0.5.3",
+    "@emseepea/feedback": "0.2.0",
+    "@emseepea/testing": "0.9.3",
+    "@modelcontextprotocol/client": "2.0.0",
     "@types/node": "24.13.3",
     "typescript": "6.0.3",
     "oxlint": "1.80.0"
@@ -24,7 +26,7 @@
   },
   "private": true,
   "dependencies": {
-    "@emseepea/server": "0.3.3",
+    "@emseepea/server": "0.6.1",
     "zod": "4.4.3"
   }
 }

package/initializer-dist/template/src/app.ts

@@ -0,0 +1,21 @@
+import {
+  createEmseepea,
+  discoverCapabilities,
+  type AccessPolicy,
+  type EmseepeaExtensions,
+} from "@emseepea/server";
+
+export interface ProgressStreamingServerOptions extends EmseepeaExtensions {
+  readonly access?: AccessPolicy;
+}
+
+export async function createProgressStreamingServer(options: ProgressStreamingServerOptions = {}) {
+  const { access = { access: "public" }, ...extensions } = options;
+  return createEmseepea({
+    name: "emseepea-progress-streaming-server",
+    version: "0.0.0",
+    instructions: "Use run-germination-trial for the sample pea germination trial.",
+    ...await discoverCapabilities(new URL("./capabilities/", import.meta.url), access),
+    ...extensions,
+  });
+}

package/initializer-dist/template/src/capabilities/tool.run-germination-trial.ts

@@ -1,10 +1,15 @@
 import { setTimeout as delay } from "node:timers/promises";
-import { defineStreamingTool, type CapabilityModuleFactory } from "@emseepea/server";
+import {
+  defineStreamingTool,
+  type AccessPolicy,
+  type CapabilityModuleFactory,
+  type StreamingToolContext,
+} from "@emseepea/server";
 import { z } from "zod";
 
-export default (() => defineStreamingTool({
+export default ((access) => defineStreamingTool({
   name: "run-germination-trial",
-  access: "public",
+  ...access,
   description: "Run a sample pea germination trial with bounded progress.",
   inputSchema: z.object({
     tray: z.literal("sample-tray").describe("Sample germination tray to test."),
@@ -17,7 +22,7 @@ export default (() => defineStreamingTool({
     stages: z.tuple([z.literal("soak"), z.literal("sow"), z.literal("sprout")])
       .describe("Trial stages completed in order."),
   }),
-  async handler({ tray }, { reportProgress, signal }) {
+  async handler({ tray }, { reportProgress, signal }: StreamingToolContext) {
     const stages: ["soak", "sow", "sprout"] = ["soak", "sow", "sprout"];
     for (const [index, stage] of stages.entries()) {
       await reportProgress({ progress: index + 1, total: stages.length, message: stage });
@@ -26,4 +31,4 @@ export default (() => defineStreamingTool({
     const data = { tray, status: "complete" as const, germinatedSeeds: 8 as const, totalSeeds: 10 as const, stages };
     return { data };
   },
-})) satisfies CapabilityModuleFactory;
+})) satisfies CapabilityModuleFactory<AccessPolicy>;

package/initializer-dist/template/src/server.ts

@@ -1,11 +1,9 @@
-import { createEmseepea, discoverCapabilities, serveEmseepea } from "@emseepea/server";
+import { serveEmseepea } from "@emseepea/server";
+import { createProgressStreamingServer } from "./app.js";
 
-const running = await serveEmseepea(createEmseepea({
-  name: "emseepea-progress-streaming-server",
-  version: "0.0.0",
-  instructions: "Use run-germination-trial for the sample pea germination trial.",
-  ...await discoverCapabilities(new URL("./capabilities/", import.meta.url)),
-}), { port: Number.parseInt(process.env.PORT ?? "3000", 10) });
+const running = await serveEmseepea(await createProgressStreamingServer(), {
+  port: Number.parseInt(process.env.PORT ?? "3000", 10),
+});
 
 console.log(`Em See Pea progress-streaming-server example listening at ${running.url}`);
 

package/initializer-dist/template/test/server.test.mjs

@@ -1,7 +1,16 @@
 import assert from "node:assert/strict";
+import { once } from "node:events";
+import { createServer, request } from "node:http";
 import test from "node:test";
 
-import { startMcpServer } from "@emseepea/testing";
+import { Client, StreamableHTTPClientTransport } from "@modelcontextprotocol/client";
+import { serveEmseepea } from "@emseepea/server";
+import {
+  insecureTestAuthentication,
+  startEmseepea,
+  startMcpServer,
+} from "@emseepea/testing";
+import { createProgressStreamingServer } from "../dist/app.js";
 
 test("reports bounded progress before returning the final germination result", async (t) => {
   const running = await startMcpServer(t, new URL("../dist/server.js", import.meta.url));
@@ -29,3 +38,137 @@ test("reports bounded progress before returning the final germination result", a
   });
   assert.equal(result.content[0].text, JSON.stringify(result.structuredContent));
 });
+
+test("the same template composes protected access and observability", async (t) => {
+  const events = [];
+  const permissions = ["trials:run"];
+  const running = await startEmseepea(t, await createProgressStreamingServer({
+    access: { access: "protected", requiredScopes: permissions },
+    authentication: insecureTestAuthentication(permissions),
+    observability: [{ id: "test-log", emit: (event) => events.push(event) }],
+  }));
+  const client = await running.connect("test-token");
+  const progress = [];
+  const result = await client.callTool(
+    { name: "run-germination-trial", arguments: { tray: "sample-tray" } },
+    { onprogress: (update) => progress.push(update) },
+  );
+  assert.deepEqual(progress.map(({ message }) => message), ["soak", "sow", "sprout"]);
+  assert.equal(result.structuredContent.status, "complete");
+  assert.ok(events.some(({ capability }) => capability === "run-germination-trial"));
+});
+
+test("protected progress crosses a trusted proxy through official and raw clients", async (t) => {
+  const permissions = ["trials:run"];
+  const backend = await serveEmseepea(await createProgressStreamingServer({
+    access: { access: "protected", requiredScopes: permissions },
+    authentication: insecureTestAuthentication(permissions, "public"),
+    deployment: {
+      mode: "production-behind-proxy",
+      trustedProxyAddresses: ["127.0.0.1"],
+      allowedAuthorities: ["test.example"],
+      allowedOrigins: ["https://test.example"],
+      rateLimit: { maxRequests: 20, windowMs: 1_000, maxClients: 1 },
+    },
+  }), { port: 0 });
+  const proxy = await startTrustedProxy(backend.url);
+  t.after(async () => {
+    proxy.closeAllConnections();
+    await new Promise((resolve) => proxy.close(resolve));
+    await backend.close();
+  });
+  const url = new URL(`http://127.0.0.1:${proxy.address().port}/mcp`);
+
+  const client = new Client(
+    { name: "packed-progress-test", version: "0.0.0" },
+    { versionNegotiation: { mode: { pin: "2026-07-28" } } },
+  );
+  try {
+    await client.connect(new StreamableHTTPClientTransport(url, {
+      requestInit: { headers: {
+        Accept: "application/json, text/event-stream",
+        Authorization: "Bearer official-token",
+      } },
+    }));
+    const progress = [];
+    const result = await client.callTool(
+      { name: "run-germination-trial", arguments: { tray: "sample-tray" } },
+      { onprogress: (update) => progress.push(update) },
+    );
+    assert.ok(proxy.requestBodies.some((body) => body.includes('"progressToken"')));
+    assert.equal(proxy.responseTypes.at(-1), "text/event-stream");
+    assert.deepEqual(progress.map(({ message }) => message), ["soak", "sow", "sprout"]);
+    assert.equal(result.structuredContent.tray, "sample-tray");
+  } finally {
+    await client.close();
+  }
+
+  const response = await fetch(url, rawCall("raw-token"));
+  assert.equal(response.status, 200);
+  assert.match(response.headers.get("content-type"), /^text\/event-stream/);
+  const messages = (await response.text()).trim().split("\n\n").map((frame) =>
+    JSON.parse(frame.slice(frame.indexOf("data: ") + 6)));
+  assert.deepEqual(messages.slice(0, -1).map(({ params }) => params.message), ["soak", "sow", "sprout"]);
+  assert.equal(messages.at(-1).result.structuredContent.tray, "sample-tray");
+  assert.doesNotMatch(JSON.stringify(messages), /raw-token/);
+});
+
+async function startTrustedProxy(backendUrl) {
+  const requestBodies = [];
+  const responseTypes = [];
+  const proxy = createServer((incoming, outgoing) => {
+    const chunks = [];
+    incoming.on("data", (chunk) => chunks.push(chunk));
+    incoming.on("end", () => requestBodies.push(Buffer.concat(chunks).toString("utf8")));
+    const upstream = request(new URL(incoming.url, backendUrl), {
+      method: incoming.method,
+      headers: {
+        ...incoming.headers,
+        host: "test.example",
+        "x-forwarded-for": "192.0.2.1",
+        "x-forwarded-proto": "https",
+      },
+    });
+    upstream.on("response", (response) => {
+      responseTypes.push(response.headers["content-type"]);
+      outgoing.writeHead(response.statusCode, response.headers);
+      response.pipe(outgoing);
+    });
+    upstream.on("error", () => outgoing.destroy());
+    incoming.pipe(upstream);
+  });
+  proxy.listen(0, "127.0.0.1");
+  await once(proxy, "listening");
+  proxy.requestBodies = requestBodies;
+  proxy.responseTypes = responseTypes;
+  return proxy;
+}
+
+function rawCall(token) {
+  return {
+    method: "POST",
+    headers: {
+      Accept: "application/json, text/event-stream",
+      Authorization: `Bearer ${token}`,
+      "Content-Type": "application/json",
+      "MCP-Protocol-Version": "2026-07-28",
+      "Mcp-Method": "tools/call",
+      "Mcp-Name": "run-germination-trial",
+    },
+    body: JSON.stringify({
+      jsonrpc: "2.0",
+      id: "raw-call",
+      method: "tools/call",
+      params: {
+        name: "run-germination-trial",
+        arguments: { tray: "sample-tray" },
+        _meta: {
+          "io.modelcontextprotocol/protocolVersion": "2026-07-28",
+          "io.modelcontextprotocol/clientInfo": { name: "raw-progress-test", version: "0.0.0" },
+          "io.modelcontextprotocol/clientCapabilities": {},
+          progressToken: "raw-progress",
+        },
+      },
+    }),
+  };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emseepea/create-progress-streaming-server",
-  "version": "0.0.13",
+  "version": "0.0.18",
   "description": "Create an Em See Pea server that streams tool progress.",
   "license": "MIT",
   "type": "module",
@@ -18,9 +18,11 @@
     "prepack": "npm run build:initializer"
   },
   "devDependencies": {
-    "@emseepea/server": "0.3.3",
+    "@emseepea/feedback": "0.2.0",
+    "@emseepea/server": "0.6.1",
     "zod": "4.4.3",
-    "@emseepea/testing": "0.5.3",
+    "@emseepea/testing": "0.9.3",
+    "@modelcontextprotocol/client": "2.0.0",
     "@types/node": "24.13.3",
     "typescript": "6.0.3",
     "oxlint": "1.80.0"