@waniwani/sdk 0.9.9 → 0.9.11

package/README.md

@@ -3,26 +3,28 @@
 [![npm](https://img.shields.io/npm/v/@waniwani/sdk.svg)](https://www.npmjs.com/package/@waniwani/sdk)
 [![license](https://img.shields.io/npm/l/@waniwani/sdk.svg)](./LICENSE)
 
-> The official SDK for [WaniWani](https://waniwani.ai) — build, ship, and measure conversational MCP apps.
+> The official SDK for [WaniWani](https://waniwani.ai). Build, ship, and measure conversational MCP apps.
 
-`@waniwani/sdk` is the developer-facing library that plugs into your MCP (Model Context Protocol) server and gives you **event tracking** and **multi-step conversational flows** out of the box.
+`@waniwani/sdk` is the developer-facing library for your MCP (Model Context Protocol) server. It provides **event tracking** and **multi-step conversational flows**.
 
-- **Zero runtime dependencies** — sub-5KB bundle, safe for serverless and edge runtimes.
-- **Works with any MCP runtime** — [Skybridge](https://github.com/alpic-ai/skybridge), [`@modelcontextprotocol/sdk`](https://www.npmjs.com/package/@modelcontextprotocol/sdk), [`@vercel/mcp-handler`](https://www.npmjs.com/package/@vercel/mcp-handler).
-- **Fully typed** — Zod-powered state schemas, inferred node contexts, typed event properties.
-- **Automatic tool tracking** — one line wraps your server and every tool call ships to your dashboard.
-- **LangGraph-inspired flows** — compile a state graph into a single MCP tool that drives multi-turn conversations.
+- **Zero runtime dependencies.** Sub-5KB core bundle, safe for serverless and edge runtimes.
+- **Works with any MCP runtime.** [`@modelcontextprotocol/sdk`](https://www.npmjs.com/package/@modelcontextprotocol/sdk), [Skybridge](https://github.com/alpic-ai/skybridge), [`@vercel/mcp-handler`](https://www.npmjs.com/package/@vercel/mcp-handler).
+- **Fully typed.** Zod state schemas, inferred node contexts, typed event properties.
+- **Automatic tool tracking.** One call to `withWaniwani(server)` and every tool invocation is tracked.
+- **LangGraph-inspired flows.** Compile a state graph into a single MCP tool that drives multi-turn conversations.
 
-> **Status:** pre-alpha. APIs and behaviour may change between releases — pin versions in production.
+> **Status:** pre-alpha. APIs and behavior may change between releases. Pin versions in production.
 
 ## Install
 
 ```bash
-npm install @waniwani/sdk
+bun add @waniwani/sdk
 # or
 pnpm add @waniwani/sdk
 # or
-bun add @waniwani/sdk
+npm install @waniwani/sdk
+# or
+yarn add @waniwani/sdk
 ```
 
 Requires Node 18.17+ and an MCP server runtime.
@@ -31,35 +33,40 @@ Requires Node 18.17+ and an MCP server runtime.
 
 ### 1. Get an API key
 
-Sign in to [app.waniwani.ai](https://app.waniwani.ai), create an MCP environment, and copy its API key. Expose it to your server as `WANIWANI_API_KEY`:
+Sign in to [app.waniwani.ai](https://app.waniwani.ai), create an MCP environment, and copy its API key. Keys are prefixed with `wwk_` and shown in full only once. Expose it to your server as `WANIWANI_API_KEY`:
 
 ```bash
 # .env
-WANIWANI_API_KEY=ww_live_...
+WANIWANI_API_KEY=wwk_...
 ```
 
 ### 2. Wrap your MCP server
 
 ```ts
-import { waniwani } from "@waniwani/sdk";
+import express from "express";
 import { withWaniwani } from "@waniwani/sdk/mcp";
-import { McpServer } from "skybridge/server";
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
 import "dotenv/config";
 
-const server = new McpServer(
-  { name: "my-mcp-app", version: "0.0.1" },
-  { capabilities: {} },
-);
+const server = new McpServer({ name: "my-mcp-app", version: "0.0.1" });
 
 server.registerTool(/* ... your tools ... */);
 
-// One line — every registered tool is now tracked automatically.
-withWaniwani(server, { client: waniwani() });
+// One call. Every registered tool is now tracked automatically.
+withWaniwani(server);
 
-server.run();
+// Connect the Streamable HTTP transport
+const transport = new StreamableHTTPServerTransport({ sessionIdGenerator: undefined });
+await server.connect(transport);
+
+const app = express();
+app.use(express.json());
+app.post("/mcp", (req, res) => transport.handleRequest(req, res, req.body));
+app.listen(3000);
 ```
 
-Every tool call produces a `tool.called` event with duration, status, input/output, and session correlation — all visible in your WaniWani dashboard within seconds.
+Every tool call produces a `tool.called` event with duration, status, input/output, and session correlation, all visible in your WaniWani dashboard within seconds.
 
 ### 3. Track custom events
 
@@ -111,11 +118,11 @@ export const onboardingFlow = createFlow({
 await onboardingFlow.register(server);
 ```
 
-The engine handles state persistence, resumption, branching, and validation. The model just calls one tool — everything else is managed server-side.
+The engine handles state persistence, resumption, branching, and validation. The model calls one tool and the rest is managed server-side.
 
 ## Documentation
 
-Full product documentation lives at **[docs.waniwani.ai](https://docs.waniwani.ai)** (powered by Mintlify):
+Full product documentation lives at **[docs.waniwani.ai](https://docs.waniwani.ai)**:
 
 - [Introduction](https://docs.waniwani.ai/introduction)
 - [Quickstart](https://docs.waniwani.ai/quickstart)
@@ -132,22 +139,22 @@ The same docs are also available in this repository under [`docs/`](./docs).
 | `@waniwani/sdk`           | `waniwani()` client: event tracking, identify, flush, shutdown.                |
 | `@waniwani/sdk/mcp`       | `withWaniwani`, `createFlow`, `createTool`, `createResource`, flow primitives. |
 | `@waniwani/sdk/mcp/react` | React hooks for WaniWani-powered widgets.                                      |
-| `@waniwani/sdk/chat`      | Chat UI components for embedding conversations.                                |
-| `@waniwani/sdk/kb`        | Knowledge base client.                                                         |
 
 Most users only need `@waniwani/sdk` and `@waniwani/sdk/mcp`.
 
 ## Examples
 
-- **[Alpic x WaniWani demo](https://github.com/alpic-ai/apps-sdk-template)** — a Skybridge MCP server with a full `createFlow` booking journey.
+- **[Alpic x WaniWani demo](https://github.com/WaniWani-AI/alpic-x-waniwani-demo)**: a Skybridge MCP server with a full `createFlow` booking journey.
 
 ## Links
 
-- **Website** — [waniwani.ai](https://waniwani.ai)
-- **Dashboard** — [app.waniwani.ai](https://app.waniwani.ai)
-- **Docs** — [docs.waniwani.ai](https://docs.waniwani.ai)
-- **Issues** — [github.com/WaniWani-AI/sdk/issues](https://github.com/WaniWani-AI/sdk/issues)
+- **Website**: [waniwani.ai](https://waniwani.ai)
+- **Dashboard**: [app.waniwani.ai](https://app.waniwani.ai)
+- **Docs**: [docs.waniwani.ai](https://docs.waniwani.ai)
+- **Issues**: [github.com/WaniWani-AI/sdk/issues](https://github.com/WaniWani-AI/sdk/issues)
 
 ## License
 
-[MIT](./LICENSE) © WaniWani
+[AGPL-3.0-or-later](./LICENSE) © WaniWani
+
+"WaniWani" is a trademark of WaniWani. The license covers the code, not the name.