@emseepea/create-progress-streaming-server 0.0.0

package/README.md

@@ -0,0 +1,22 @@
+# `@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.
+
+```sh
+npm init @emseepea/progress-streaming-server@next -- my-server
+```
+
+```sh
+cd my-server
+npm install
+npm test
+npm run lint
+npm start
+```

package/dist/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Windy Road Technology Pty. Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/create.mjs

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+
+import { cp, mkdir, mkdtemp, readFile, readdir, rm, writeFile } from "node:fs/promises";
+import { basename, dirname, join, resolve } from "node:path";
+
+const [destination, ...extra] = process.argv.slice(2);
+if (extra.length > 0 || !destination || !/^[a-z0-9][a-z0-9._-]*$/.test(destination)) {
+  throw new Error("Provide one simple lowercase destination name, such as my-server");
+}
+
+const target = resolve(destination);
+if (basename(target) !== destination) throw new Error("The destination must not contain a path");
+const staging = await mkdtemp(join(dirname(target), ".emseepea-create-"));
+
+try {
+  await copyContents(new URL("./template/", import.meta.url), staging);
+  const manifestPath = resolve(staging, "package.json");
+  const manifest = JSON.parse(await readFile(manifestPath, "utf8"));
+  await writeFile(manifestPath, `${JSON.stringify({ ...manifest, name: destination }, null, 2)}\n`);
+  await mkdir(target);
+  try {
+    await copyContents(staging, target);
+  } catch (error) {
+    await rm(target, { recursive: true, force: true });
+    throw error;
+  }
+} catch (error) {
+  if (["EEXIST", "ENOTEMPTY"].includes(error.code)) {
+    throw new Error(`The destination already exists: ${destination}`);
+  }
+  throw error;
+} finally {
+  await rm(staging, { recursive: true, force: true });
+}
+
+async function copyContents(source, destination) {
+  for (const entry of await readdir(source)) {
+    const from = source instanceof URL ? new URL(entry, source) : join(source, entry);
+    await cp(from, join(destination, entry), { recursive: true, errorOnExist: true, force: false });
+  }
+}
+
+console.log(`Created ${destination}.`);
+console.log(`Next: cd ${destination}; npm install; npm test; npm start`);

package/dist/template/README.md

@@ -0,0 +1,47 @@
+# 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
+npm install
+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/template/eval/meaning.test.mjs

@@ -0,0 +1,23 @@
+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/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "emseepea-starter",
+  "version": "0.0.0",
+  "private": true,
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "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"
+  },
+  "dependencies": {
+    "@emseepea/server": "0.0.4",
+    "zod": "4.4.3"
+  },
+  "devDependencies": {
+    "@emseepea/testing": "0.2.1",
+    "@types/node": "24.13.3",
+    "typescript": "6.0.3",
+    "oxlint": "1.80.0"
+  },
+  "engines": {
+    "node": ">=22"
+  }
+}

package/dist/template/src/server.ts

@@ -0,0 +1,42 @@
+import { setTimeout as delay } from "node:timers/promises";
+import { createEmseepea, defineStreamingTool, serveEmseepea } from "@emseepea/server";
+import { z } from "zod";
+
+const roastBatch = 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 };
+  },
+});
+
+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());

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

@@ -0,0 +1,22 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+
+import { startMcpServer } from "@emseepea/testing";
+
+test("reports bounded progress before returning the final roast 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" } },
+    { onprogress: (update) => progress.push(update) },
+  );
+
+  assert.deepEqual(progress.map(({ message }) => message), ["charge", "first crack", "cool"]);
+  assert.deepEqual(result.structuredContent, {
+    batch: "sample-batch",
+    status: "complete",
+    roastedGrams: 820,
+    stages: ["charge", "first crack", "cool"],
+  });
+});

package/dist/template/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "dist",
+    "rootDir": "src",
+    "strict": true,
+    "target": "ES2023",
+    "types": ["node"],
+    "verbatimModuleSyntax": true
+  },
+  "include": ["src/**/*.ts"]
+}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@emseepea/create-progress-streaming-server",
+  "version": "0.0.0",
+  "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": false,
+    "tag": "next"
+  },
+  "type": "module",
+  "bin": {
+    "create-progress-streaming-server": "./dist/create.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22"
+  }
+}