agentic-scaffold 0.1.1 → 0.1.2

package/README.md

@@ -1,108 +1,74 @@
-# Agentic scaffold
+# agentic-scaffold
 
-Canonical scaffold for a CLI plus library plus MCP server pack.
+[![npm version](https://img.shields.io/npm/v/agentic-scaffold)](https://www.npmjs.com/package/agentic-scaffold)
+[![Monthly downloads](https://img.shields.io/npm/dm/agentic-scaffold)](https://www.npmjs.com/package/agentic-scaffold)
+[![MIT license](https://img.shields.io/badge/license-MIT-blue)](https://opensource.org/license/mit)
 
-Clone this repo to start a new pack. It gives one core with three
-faces: a terminal command, an npm import, and an MCP server.
+[Package](https://www.npmjs.com/package/agentic-scaffold) · [Source](https://github.com/pooriaarab/agentic-scaffold) · [Support](https://github.com/pooriaarab/agentic-scaffold/issues)
 
-## What you get
+agentic-scaffold is an open-source TypeScript starter for developers who need a Node.js library, command-line interface, and Model Context Protocol (MCP) server.
 
-- One core: brand config, logs, guards, routing, dry run, cost reports.
-- Three faces over that core: CLI, library, MCP server.
-- A frozen core contract, so packs share one API.
-- A worker entry and a wrangler sample for edge deploys.
-- Build, typecheck, and tests that pass from a fresh clone.
-
-## Quick start
+## Install
 
 ```sh
-git clone https://github.com/pooriaarab/agentic-scaffold.git my-pack
-cd my-pack
-npm install
-npm run build
-npm run typecheck
-npm test
+npm install agentic-scaffold
 ```
 
-Run the command:
+Requires Node.js 18 or later. Includes TypeScript declarations and two direct dependencies: the MCP SDK and Zod.
+
+## Run your first summary
+
+No credentials, environment variables, or `.env` loader are required.
 
 ```sh
-node dist/cli.js summary --text "hello world hello"
+npx agentic-scaffold summary --text "hello world hello"
 ```
 
-Call the library:
+Success prints JSON with `chars: 17`, `words: 3`, `lines: 1`, and `hello` counted twice.
 
 ```js
-import { summarizeText } from "./dist/index.js";
-
+import { summarizeText, getCostReport } from "agentic-scaffold";
 console.log(summarizeText("hello world hello"));
+console.log(getCostReport()); // { entries: [], dispatches: 0, units: 0 }
 ```
 
-Start the MCP server:
-
-```sh
-node dist/cli.js mcp
-```
-
-## Three usecases
-
-1. You run one text summary from the terminal.
-2. You import the summary function in a script.
-3. You let an agent call the same function as an MCP tool.
-
-## Clone checklist
+## Features and runtime surfaces
 
-This repo is a template. Replace each slot in each file that holds it.
+- **Text statistics:** Character, word, line, and top-word counts; no semantic summarization.
+- **Routing:** Two generic adapters: local receipts and HTTP POST with `{ text }`.
+- **Guards:** Optional dispatch caps, UTC quiet hours, and text blocklists.
+- **Utilities:** Brand configuration, stderr logging, dry-run results, and in-memory cost units.
+- **CLI:** `summary`, `dispatch`, `costs`, `mcp`; help via `--help` and version via `--version`.
+- **MCP:** Three tools: `summarize_text`, `dispatch_text`, `get_cost_report`.
+- **Worker scaffold:** Source handler for `GET /health` and `POST /summarize`; users deploy it themselves.
 
-- `__PACK_NAME__`: the directory name, like `my-pack`.
-- `__NPM_NAME__`: the npm name, like `agentic-<block>` (bare name, never @pooriaarab/ scoped unless the brief says scoped).
-- `__PACK_COMMAND__`: the terminal command, like `my-pack`.
-- `__PACK_DESCRIPTION__`: one plain sentence, under 100 chars.
-- `__PACK_KEYWORDS__`: plain keywords, like `notes, search, cli`.
-- `__GITHUB_USER__`: the repo owner, like `pooriaarab`.
+Start MCP with `npx agentic-scaffold mcp`. Preview routing with `npx agentic-scaffold dispatch --text hello --dry-run`.
 
-Slot files: `AGENTS.md`, `SKILL.md`, `RULES.md`, `llms.txt`,
-`server.json`, `.mcp.json`, `wrangler.jsonc`.
+## Limits
 
-Then rename the scaffold identity itself:
+This starter has zero vendor-specific integrations. Local dispatch creates a receipt without external delivery.
+CLI and MCP dispatch use the local adapter by default; SDK callers can supply the HTTP adapter.
+HTTP delivery defaults to a ten-second timeout, with no retries. Cost units count text length rather than billing charges.
+Reports reset when the process exits. CLI help and MCP identity still use the starter name `agentic-pack`.
 
-- `package.json`: name, bin commands, mcpName. Remove `"private": true`.
-- `src/index.ts`: the `DEFAULT_BRAND` fields.
-- This file: the pitch and the examples above.
-
-At publish time, set `server.json` version to the npm version and
-`server.json` repository id from `gh api repos/OWNER/REPO --jq .id`.
-
-## Gates
-
-Run all three before you push a pack:
+## Customize a cloned starter
 
 ```sh
+git clone https://github.com/pooriaarab/agentic-scaffold.git my-pack
+cd my-pack
+npm ci
 npm run build && npm run typecheck && npm test
+node dist/cli.js summary --text "hello world hello"
 ```
 
-Then run the real installed CLI once from a tarball:
-
-```sh
-npm pack
-npx --yes --package ./pooriaarab-agentic-scaffold-0.1.0.tgz agentic-pack summary --text "hello"
-```
-
-## Release flow
-
-Push to `main` for review. Merge to `release` to publish. The
-publish workflow ships only when the version is new.
-
-## Layout
+Replace `__PACK_NAME__`, `__NPM_NAME__`, `__PACK_COMMAND__`, `__PACK_DESCRIPTION__`, `__PACK_KEYWORDS__`, and `__GITHUB_USER__` wherever they appear.
+Check `AGENTS.md`, `SKILL.md`, `RULES.md`, `llms.txt`, `server.json`, `.mcp.json`, and `wrangler.jsonc`.
+Update package identity, bin commands, `mcpName`, and `DEFAULT_BRAND` in `src/index.ts`.
+Set the MCP manifest version and repository ID before publishing your own package.
 
-- `src/index.ts`: the library face.
-- `src/cli.ts`: the terminal face.
-- `src/mcp.ts`: the MCP server. `src/mcp-bin.ts` starts it.
-- `src/worker.ts`: the edge worker face.
-- `src/core.ts`: the shared core.
-- `agentic-core.d.ts`: the frozen contract.
-- `docs/agentic-core.md`: the contract in plain words.
+The repository includes a shared core contract and a publish workflow. Inspect that workflow before adopting its release process.
+Version 0.1.1 is an early starter release; interfaces can change.
 
 ## License
 
-MIT. See `LICENSE`.
+MIT.

package/dist/{chunk-USTEVUWE.js → chunk-FYTHYRXT.js}

@@ -1,6 +1,6 @@
 import {
   DEFAULT_BRAND
-} from "./chunk-P7R4J6SZ.js";
+} from "./chunk-QWFNPAA4.js";
 import {
   GuardError,
   LocalRouterAdapter,
@@ -9,7 +9,7 @@ import {
   dispatchText,
   getCostReport,
   summarizeText
-} from "./chunk-E72J53UI.js";
+} from "./chunk-USJ2R2T2.js";
 
 // src/mcp.ts
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";

package/dist/{chunk-P7R4J6SZ.js → chunk-QWFNPAA4.js}

@@ -1,7 +1,7 @@
 import {
   VERSION,
   defineBrand
-} from "./chunk-E72J53UI.js";
+} from "./chunk-USJ2R2T2.js";
 
 // src/index.ts
 var DEFAULT_BRAND = defineBrand({

package/dist/{chunk-E72J53UI.js → chunk-USJ2R2T2.js}

@@ -206,7 +206,7 @@ function summarizeText(text, options = {}) {
 
 // src/version.ts
 import { createRequire } from "module";
-var VERSION = true ? "0.1.1" : readPackageVersion();
+var VERSION = true ? "0.1.2" : readPackageVersion();
 
 export {
   defineBrand,

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import {
   DEFAULT_BRAND
-} from "./chunk-P7R4J6SZ.js";
+} from "./chunk-QWFNPAA4.js";
 import {
   GuardError,
   LocalRouterAdapter,
@@ -10,7 +10,7 @@ import {
   dispatchText,
   getCostReport,
   summarizeText
-} from "./chunk-E72J53UI.js";
+} from "./chunk-USJ2R2T2.js";
 
 // src/cli.ts
 import { readFileSync, realpathSync } from "fs";

package/dist/index.js

@@ -1,6 +1,6 @@
 import {
   DEFAULT_BRAND
-} from "./chunk-P7R4J6SZ.js";
+} from "./chunk-QWFNPAA4.js";
 import {
   GuardError,
   HttpRouterAdapter,
@@ -16,7 +16,7 @@ import {
   recordCost,
   resetCosts,
   summarizeText
-} from "./chunk-E72J53UI.js";
+} from "./chunk-USJ2R2T2.js";
 export {
   DEFAULT_BRAND,
   GuardError,

package/dist/mcp-bin.js

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 import {
   startMcp
-} from "./chunk-USTEVUWE.js";
-import "./chunk-P7R4J6SZ.js";
-import "./chunk-E72J53UI.js";
+} from "./chunk-FYTHYRXT.js";
+import "./chunk-QWFNPAA4.js";
+import "./chunk-USJ2R2T2.js";
 
 // src/mcp-bin.ts
 startMcp().catch((error) => {

package/dist/mcp.js

@@ -1,9 +1,9 @@
 import {
   createMcpServer,
   startMcp
-} from "./chunk-USTEVUWE.js";
-import "./chunk-P7R4J6SZ.js";
-import "./chunk-E72J53UI.js";
+} from "./chunk-FYTHYRXT.js";
+import "./chunk-QWFNPAA4.js";
+import "./chunk-USJ2R2T2.js";
 export {
   createMcpServer,
   startMcp

package/dist/worker.js

@@ -1,7 +1,7 @@
 import {
   VERSION,
   summarizeText
-} from "./chunk-E72J53UI.js";
+} from "./chunk-USJ2R2T2.js";
 
 // src/worker.ts
 function json(value, status = 200) {

package/package.json

@@ -1,13 +1,21 @@
 {
   "name": "agentic-scaffold",
-  "version": "0.1.1",
-  "description": "Canonical scaffold for a CLI plus library plus MCP server pack.",
+  "version": "0.1.2",
+  "description": "TypeScript scaffold for a Node.js library, CLI, and MCP server with Zod schemas, text statistics, routing adapters, and dispatch guards.",
   "keywords": [
+    "typescript",
+    "Node.js",
     "cli",
     "mcp",
+    "Model Context Protocol",
+    "Zod",
     "scaffold",
     "starter",
-    "typescript"
+    "sdk",
+    "text-statistics",
+    "http",
+    "dispatch",
+    "guards"
   ],
   "license": "MIT",
   "author": "Pooria Arab",