@emseepea/create-progress-streaming-server 0.0.2 → 0.0.4

package/README.md

@@ -1,22 +1,65 @@
 # `@emseepea/create-progress-streaming-server`
 
-Create a private, standalone Em See Pea project whose tool streams progress.
-The package builds its starter from the maintained
-[progress streaming example](https://github.com/emseepea/emseepea/tree/main/examples/streaming-progress).
+This directory is both the maintained example and its public npm initializer.
 
-## Create the Project
+## Use This Template
 
-This initializer is queued for the next pre-alpha release and is not yet
-available from npm.
+Use this template for a tool that reports bounded progress while its HTTP call
+remains open. Choose the [tool server](../tool-server/README.md) when the result
+can return promptly. This template does not add replay, reconnectable sessions,
+or subscriptions. [Compare all eight templates](https://emseepea.github.io/emseepea/examples/).
+
+## Create a Project
 
 ```sh
-npm init @emseepea/progress-streaming-server@next -- my-server
+npm init @emseepea/progress-streaming-server -- my-server
 ```
 
+<!-- generated-project-readme -->
+
+## 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
+server-sent events (SSE), which carry progress over the same `POST` request.
+Without that request, the tool returns one JSON response when it finishes.
+
+## Run
+
+From this directory:
+
 ```sh
-cd my-server
 npm install
-npm test
-npm run lint
+npm run build
 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
+[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.
+
+## Check This Example
+
+[Ordinary tests](test/) live in `test/`.
+The [AI tool-choice and understanding test](eval/meaning.test.mjs) lives separately in `eval/`.
+The commands below run each suite independently.
+
+Run its build and progress-stream checks:
+
+```sh
+npm test
+```
+
+Check that Claude chooses the germination tool and keeps progress separate from the result:
+
+```sh
+npm run test:llm
+```
+
+If Claude is not already signed in, run `claude auth login` first.

package/{dist → initializer-dist}/template/README.md

@@ -22,9 +22,8 @@ choose another port. This example starts locally and does not configure a proxy.
 
 To adapt it for a public server, see
 [Use Progress Behind a Proxy](https://github.com/emseepea/emseepea/blob/main/packages/framework/README.md#use-progress-behind-a-proxy).
-That option is available in the current source, not yet in a published npm
-release. It does not add saved sessions, replay, subscriptions, or recovery
-after reconnecting.
+It does not add saved sessions, replay, subscriptions, or recovery after
+reconnecting.
 
 ## Check This Example
 
@@ -38,7 +37,7 @@ Run its build and progress-stream checks:
 npm test
 ```
 
-Check that Claude chooses the roast tool and keeps progress separate from the result:
+Check that Claude chooses the germination tool and keeps progress separate from the result:
 
 ```sh
 npm run test:llm

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

@@ -0,0 +1,24 @@
+import { toolSelectionTest } from "@emseepea/testing/semantic";
+
+toolSelectionTest("Progress stages remain distinct from the final germination result", {
+  server: new URL("../dist/server.js", import.meta.url),
+  question:
+    "Run the sample-tray pea germination trial. Name the tray, list the progress " +
+    "stages, and report the final status and germination result. Keep progress and the completed result " +
+    "distinct.",
+  criticalFacts: [
+    "sample-tray",
+    "soak",
+    "sow",
+    "sprout",
+    "complete",
+    "8",
+    "10"
+  ],
+  criteria:
+    "The answer identifies soak, sow, and sprout as progress stages, then " +
+    "separately reports the completed final result of 8 out of 10 germinated seeds " +
+    "for sample-tray. It does not treat an intermediate progress stage as the final " +
+    "result.",
+  expectedTools: ["run-germination-trial"],
+});

package/{dist → initializer-dist}/template/package.json

@@ -1,7 +1,7 @@
 {
   "name": "emseepea-starter",
   "version": "0.0.0",
-  "private": true,
+  "description": "Create an Em See Pea server that streams tool progress.",
   "license": "MIT",
   "type": "module",
   "scripts": {
@@ -13,17 +13,18 @@
     "test:llm:built": "emseepea-test eval",
     "lint": "oxlint src test eval"
   },
-  "dependencies": {
-    "@emseepea/server": "0.1.0",
-    "zod": "4.4.3"
-  },
   "devDependencies": {
-    "@emseepea/testing": "0.2.1",
+    "@emseepea/testing": "0.2.2",
     "@types/node": "24.13.3",
     "typescript": "6.0.3",
     "oxlint": "1.80.0"
   },
   "engines": {
     "node": ">=22"
+  },
+  "private": true,
+  "dependencies": {
+    "@emseepea/server": "0.2.2",
+    "zod": "4.4.3"
   }
 }

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

@@ -0,0 +1,26 @@
+import { setTimeout as delay } from "node:timers/promises";
+import { defineStreamingTool, type CapabilityModuleFactory } from "@emseepea/server";
+import { z } from "zod";
+
+export default (() => defineStreamingTool({
+  name: "run-germination-trial",
+  access: "public",
+  description: "Run a sample pea germination trial with bounded progress.",
+  inputSchema: z.object({ tray: z.literal("sample-tray") }),
+  outputSchema: z.object({
+    tray: z.literal("sample-tray"),
+    status: z.literal("complete"),
+    germinatedSeeds: z.literal(8),
+    totalSeeds: z.literal(10),
+    stages: z.tuple([z.literal("soak"), z.literal("sow"), z.literal("sprout")]),
+  }),
+  async handler({ tray }, { reportProgress, signal }) {
+    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 });
+      await delay(150, undefined, { signal });
+    }
+    const data = { tray, status: "complete" as const, germinatedSeeds: 8 as const, totalSeeds: 10 as const, stages };
+    return { text: `${tray} completed with 8 of 10 pea seeds germinated`, data };
+  },
+})) satisfies CapabilityModuleFactory;

package/{dist → initializer-dist}/template/src/server.ts

@@ -1,13 +1,13 @@
 import { createEmseepea, discoverCapabilities, serveEmseepea } from "@emseepea/server";
 
 const running = await serveEmseepea(createEmseepea({
-  name: "emseepea-streaming-progress",
+  name: "emseepea-progress-streaming-server",
   version: "0.0.0",
-  instructions: "Use roast-sample-batch for the sample roast run.",
+  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) });
 
-console.log(`Em See Pea streaming-progress example listening at ${running.url}`);
+console.log(`Em See Pea progress-streaming-server example listening at ${running.url}`);
 
 async function shutdown(): Promise<void> {
   await running.close();

package/{dist → initializer-dist}/template/test/server.test.mjs

@@ -3,20 +3,21 @@ import test from "node:test";
 
 import { startMcpServer } from "@emseepea/testing";
 
-test("reports bounded progress before returning the final roast result", async (t) => {
+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));
   const client = await running.connect();
   const progress = [];
   const result = await client.callTool(
-    { name: "roast-sample-batch", arguments: { batch: "sample-batch" } },
+    { name: "run-germination-trial", arguments: { tray: "sample-tray" } },
     { onprogress: (update) => progress.push(update) },
   );
 
-  assert.deepEqual(progress.map(({ message }) => message), ["charge", "first crack", "cool"]);
+  assert.deepEqual(progress.map(({ message }) => message), ["soak", "sow", "sprout"]);
   assert.deepEqual(result.structuredContent, {
-    batch: "sample-batch",
+    tray: "sample-tray",
     status: "complete",
-    roastedGrams: 820,
-    stages: ["charge", "first crack", "cool"],
+    germinatedSeeds: 8,
+    totalSeeds: 10,
+    stages: ["soak", "sow", "sprout"],
   });
 });

package/package.json

@@ -1,22 +1,37 @@
 {
   "name": "@emseepea/create-progress-streaming-server",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Create an Em See Pea server that streams tool progress.",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/emseepea/emseepea.git",
-    "directory": "packages/create-progress-streaming-server"
-  },
-  "homepage": "https://emseepea.github.io/emseepea/examples/",
-  "bugs": "https://github.com/emseepea/emseepea/issues",
-  "publishConfig": { "access": "public", "provenance": true, "tag": "next" },
   "type": "module",
-  "bin": { "create-progress-streaming-server": "./dist/create.mjs" },
-  "files": ["dist"],
+  "starterDependencies": ["@emseepea/server", "zod"],
   "scripts": {
-    "build": "node ../../scripts/build-initializer.mjs",
-    "prepack": "npm run build"
+    "build": "npm run build:example && npm run build:initializer",
+    "build:example": "tsc -p tsconfig.json",
+    "build:initializer": "node ../../scripts/build-initializer.mjs",
+    "start": "node dist/server.js",
+    "test": "npm run build && npm run test:built",
+    "test:built": "node --test test/*.test.mjs",
+    "test:llm": "npm run build && npm run test:llm:built",
+    "test:llm:built": "emseepea-test eval",
+    "lint": "oxlint src test eval",
+    "prepack": "npm run build:initializer"
+  },
+  "devDependencies": {
+    "@emseepea/server": "0.2.2",
+    "zod": "4.4.3",
+    "@emseepea/testing": "0.2.2",
+    "@types/node": "24.13.3",
+    "typescript": "6.0.3",
+    "oxlint": "1.80.0"
   },
-  "engines": { "node": ">=22" }
+  "engines": {
+    "node": ">=22"
+  },
+  "repository": { "type": "git", "url": "git+https://github.com/emseepea/emseepea.git", "directory": "examples/progress-streaming-server" },
+  "homepage": "https://emseepea.github.io/emseepea/examples/",
+  "bugs": "https://github.com/emseepea/emseepea/issues",
+  "publishConfig": { "access": "public", "provenance": true },
+  "bin": { "create-progress-streaming-server": "./initializer-dist/create.mjs" },
+  "files": ["initializer-dist"]
 }

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

@@ -1,23 +0,0 @@
-import { toolSelectionTest } from "@emseepea/testing/semantic";
-
-toolSelectionTest("Progress stages remain distinct from the final roast result", {
-  server: new URL("../dist/server.js", import.meta.url),
-  question:
-    "Run sample-batch. Name the batch, list the progress stages, and report the " +
-    "final status and final roasted mass. Keep progress and the completed result " +
-    "distinct.",
-  criticalFacts: [
-    "sample-batch",
-    "charge",
-    "first crack",
-    "cool",
-    "complete",
-    "820"
-  ],
-  criteria:
-    "The answer identifies charge, first crack, and cool as progress stages, then " +
-    "separately reports the completed final result of 820 roasted grams for " +
-    "sample-batch. It does not treat an intermediate progress stage as the final " +
-    "result.",
-  expectedTools: ["roast-sample-batch"],
-});

package/dist/template/src/capabilities/tool.roast-sample-batch.ts

@@ -1,25 +0,0 @@
-import { setTimeout as delay } from "node:timers/promises";
-import { defineStreamingTool, type CapabilityModuleFactory } from "@emseepea/server";
-import { z } from "zod";
-
-export default (() => defineStreamingTool({
-  name: "roast-sample-batch",
-  access: "public",
-  description: "Run a sample coffee-roasting batch with bounded progress.",
-  inputSchema: z.object({ batch: z.literal("sample-batch") }),
-  outputSchema: z.object({
-    batch: z.literal("sample-batch"),
-    status: z.literal("complete"),
-    roastedGrams: z.literal(820),
-    stages: z.tuple([z.literal("charge"), z.literal("first crack"), z.literal("cool")]),
-  }),
-  async handler({ batch }, { reportProgress, signal }) {
-    const stages: ["charge", "first crack", "cool"] = ["charge", "first crack", "cool"];
-    for (const [index, stage] of stages.entries()) {
-      await reportProgress({ progress: index + 1, total: stages.length, message: stage });
-      await delay(150, undefined, { signal });
-    }
-    const data = { batch, status: "complete" as const, roastedGrams: 820 as const, stages };
-    return { text: `${batch} completed at 820 roasted grams`, data };
-  },
-})) satisfies CapabilityModuleFactory;