@emseepea/create-progress-streaming-server 0.0.1 → 0.0.3

package/README.md

@@ -1,22 +1,57 @@
 # `@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).
-
-## Create the Project
-
-This initializer is queued for the next pre-alpha release and is not yet
-available from npm.
+This directory is both the maintained example and its public npm initializer.
 
 ```sh
 npm init @emseepea/progress-streaming-server@next -- 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).
+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.
+
+## 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 roast 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/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,10 +13,6 @@
     "test:llm:built": "emseepea-test eval",
     "lint": "oxlint src test eval"
   },
-  "dependencies": {
-    "@emseepea/server": "0.0.4",
-    "zod": "4.4.3"
-  },
   "devDependencies": {
     "@emseepea/testing": "0.2.1",
     "@types/node": "24.13.3",
@@ -25,5 +21,10 @@
   },
   "engines": {
     "node": ">=22"
+  },
+  "private": true,
+  "dependencies": {
+    "@emseepea/server": "0.2.1",
+    "zod": "4.4.3"
   }
 }

package/{dist/template/src/server.ts → initializer-dist/template/src/capabilities/tool.roast-sample-batch.ts}

@@ -1,8 +1,8 @@
 import { setTimeout as delay } from "node:timers/promises";
-import { createEmseepea, defineStreamingTool, serveEmseepea } from "@emseepea/server";
+import { defineStreamingTool, type CapabilityModuleFactory } from "@emseepea/server";
 import { z } from "zod";
 
-const roastBatch = defineStreamingTool({
+export default (() => defineStreamingTool({
   name: "roast-sample-batch",
   access: "public",
   description: "Run a sample coffee-roasting batch with bounded progress.",
@@ -22,21 +22,4 @@ const roastBatch = defineStreamingTool({
     const data = { batch, status: "complete" as const, roastedGrams: 820 as const, stages };
     return { text: `${batch} completed at 820 roasted grams`, data };
   },
-});
-
-const running = await serveEmseepea(createEmseepea({
-  name: "emseepea-streaming-progress",
-  version: "0.0.0",
-  instructions: "Use roast-sample-batch for the sample roast run.",
-  tools: [roastBatch],
-}), { port: Number.parseInt(process.env.PORT ?? "3000", 10) });
-
-console.log(`Em See Pea streaming-progress example listening at ${running.url}`);
-
-async function shutdown(): Promise<void> {
-  await running.close();
-  process.exitCode = 0;
-}
-
-process.once("SIGINT", () => void shutdown());
-process.once("SIGTERM", () => void shutdown());
+})) satisfies CapabilityModuleFactory;

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

@@ -0,0 +1,18 @@
+import { createEmseepea, discoverCapabilities, serveEmseepea } from "@emseepea/server";
+
+const running = await serveEmseepea(createEmseepea({
+  name: "emseepea-streaming-progress",
+  version: "0.0.0",
+  instructions: "Use roast-sample-batch for the sample roast run.",
+  ...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}`);
+
+async function shutdown(): Promise<void> {
+  await running.close();
+  process.exitCode = 0;
+}
+
+process.once("SIGINT", () => void shutdown());
+process.once("SIGTERM", () => void shutdown());

package/package.json

@@ -1,22 +1,37 @@
 {
   "name": "@emseepea/create-progress-streaming-server",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "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"
+  "type": "module",
+  "starterDependencies": ["@emseepea/server", "zod"],
+  "scripts": {
+    "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.1",
+    "zod": "4.4.3",
+    "@emseepea/testing": "0.2.1",
+    "@types/node": "24.13.3",
+    "typescript": "6.0.3",
+    "oxlint": "1.80.0"
+  },
+  "engines": {
+    "node": ">=22"
   },
+  "repository": { "type": "git", "url": "git+https://github.com/emseepea/emseepea.git", "directory": "examples/streaming-progress" },
   "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"],
-  "scripts": {
-    "build": "node ../../scripts/build-initializer.mjs",
-    "prepack": "npm run build"
-  },
-  "engines": { "node": ">=22" }
+  "bin": { "create-progress-streaming-server": "./initializer-dist/create.mjs" },
+  "files": ["initializer-dist"]
 }