@mantyx/sdk 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,35 @@
+# Changelog
+
+All notable changes to `@mantyx/sdk` are documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] — 2026-05-02
+
+### Added
+
+- Initial release of `@mantyx/sdk`.
+- `RunSpec.agentId` / `SessionSpec.agentId` — trigger a persisted MANTYX
+  agent by id instead of defining an ephemeral one inline. The server
+  hydrates the system prompt, model, and the agent's own tools (memory,
+  skills, plugin tools, …) from the `Agent` row at run time. Any extra
+  `tools` you pass on the request are merged on top — typically local
+  tools the agent should call back into for that run. `systemPrompt` is
+  now optional whenever `agentId` is set.
+- `MantyxClient` for the public agent-runs HTTP/SSE protocol.
+- `runAgent`, `streamAgent` for one-shot ephemeral agent runs.
+- `createSession`, `resumeSession`, `endSession` for multi-turn sessions.
+- `listModels` for the workspace's model catalog (BYOK + platform offerings).
+- `defineLocalTool`, `mantyxTool`, `mantyxPluginTool` tool helpers.
+- Zod → JSON Schema conversion for local tool parameters.
+- Inline SSE parser (no extra deps) with `Last-Event-ID` reconnect support.
+- Custom error hierarchy: `MantyxError`, `MantyxAuthError`,
+  `MantyxNetworkError`, `MantyxRunError`, `MantyxToolError`.
+- Self-contained example projects under `examples/`.
+- Vitest-driven mock server tests for runs, sessions, and the model catalog.
+
+[Unreleased]: https://github.com/mantyx/aos/compare/sdk-typescript-v0.1.0...HEAD
+[0.1.0]: https://github.com/mantyx/aos/releases/tag/sdk-typescript-v0.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,78 @@
+# Contributing to `@mantyx/sdk`
+
+Thanks for considering a contribution! This SDK is a small, dependency-light
+client for the [MANTYX](https://mantyx.com) agent-runs HTTP/SSE protocol; the
+goal is to keep it that way.
+
+## Ground rules
+
+1. **Public-protocol only.** The SDK MUST NOT depend on any MANTYX-internal
+   package, type, or repository layout. Anything it does is a side effect of
+   sending HTTP requests against the public protocol documented in
+   [`docs/agent-runs-protocol.md`](./docs/agent-runs-protocol.md).
+2. **No `workspace:*`.** The SDK ships to npm as a standalone package. Pull
+   requests that introduce a `workspace:*` dependency in `package.json` will
+   not be merged.
+3. **Tiny dep tree.** The only runtime dependency today is `zod`. Adding a
+   new runtime dependency requires a strong justification.
+4. **Standalone tests.** `pnpm test` must pass with `node_modules/` populated
+   from this package's own `package.json`, with no MANTYX server running.
+5. **Backwards compatibility.** Bump the SDK version per
+   [SemVer](https://semver.org/spec/v2.0.0.html). Breaking changes need a
+   major version bump and a `CHANGELOG.md` entry.
+
+## Local setup
+
+```bash
+pnpm install
+pnpm test
+pnpm typecheck
+pnpm build
+```
+
+The repository is a pnpm monorepo, but this package is a leaf with no
+internal consumers, so it is safe to develop in isolation.
+
+## Adding tests
+
+Tests live under [`test/`](./test) and use Vitest. Network calls are routed
+through the in-process mock server in
+[`test/helpers/mock-server.ts`](./test/helpers/mock-server.ts) — extend it
+when you need to exercise a new server behaviour rather than reaching out to
+a real MANTYX instance.
+
+When fixing a bug, prefer a regression test against the mock server. When
+adding a feature, add an example under [`examples/`](./examples) that
+exercises it end-to-end.
+
+## Style
+
+- TypeScript strict mode. No `any` unless there's no choice.
+- Public types are re-exported from [`src/index.ts`](./src/index.ts). Keep
+  the public surface minimal and well-typed.
+- Use `MantyxError` (and its subclasses) for thrown errors so callers can
+  branch on `instanceof`.
+- Prefer the Web `fetch` / `ReadableStream` APIs over Node-only modules so
+  the SDK keeps working in edge / browser-like runtimes.
+
+## Pull requests
+
+1. Fork and create a feature branch.
+2. Add or update tests.
+3. `pnpm test && pnpm typecheck && pnpm build`.
+4. Update `CHANGELOG.md` under `## [Unreleased]`.
+5. Open a PR. Describe the change and any protocol implications.
+
+## Releasing
+
+Releases happen out-of-band by a MANTYX maintainer:
+
+1. Move `## [Unreleased]` content into a new version section in
+   `CHANGELOG.md`.
+2. Bump `package.json` `version`.
+3. `pnpm build && pnpm publish --access public`.
+4. Tag the commit `sdk-typescript-vX.Y.Z` and push.
+
+## Code of Conduct
+
+Be kind. Assume good intent. Be patient with reviewers and maintainers.

package/EXTRACT.md

@@ -0,0 +1,70 @@
+# Extracting `@mantyx/sdk` into its own repository
+
+The `@mantyx/sdk` package is intentionally self-contained. Lifting it out of
+the MANTYX monorepo into a public repository is a five-minute job:
+
+## Steps
+
+1. Copy this folder verbatim:
+
+   ```bash
+   cp -r packages/mantyx-sdk/ts ~/code/mantyx-sdk
+   cd ~/code/mantyx-sdk
+   ```
+
+2. Initialize git:
+
+   ```bash
+   git init -b main
+   git add .
+   git commit -m "Import @mantyx/sdk from monorepo"
+   ```
+
+3. Re-generate the lockfile against npm:
+
+   ```bash
+   rm -rf node_modules
+   pnpm install   # or: npm install
+   ```
+
+4. Update `examples/*/package.json` so each example installs `@mantyx/sdk`
+   from npm rather than via the monorepo's pnpm workspace symlink. Each
+   example already sets the dep to `"@mantyx/sdk": "*"`; replace `"*"` with
+   the published version once you've cut a release.
+
+5. Confirm the test suite still passes:
+
+   ```bash
+   pnpm test
+   pnpm typecheck
+   pnpm build
+   ```
+
+6. Push to a new GitHub repo and (optionally) wire up CI by copying
+   `.github/workflows/sdk-typescript.yml` from the monorepo into
+   `.github/workflows/ci.yml` in the new repo.
+
+## What you can leave behind
+
+The following monorepo-only files do **not** apply to a standalone repo:
+
+- The MANTYX monorepo's root `pnpm-workspace.yaml`, `AGENTS.md`, `run.sh`,
+  `infra/`, `mobile/`, etc. None of them are required by the SDK.
+
+## Things to update once extracted
+
+- `package.json` `repository`, `homepage`, and `bugs` URLs.
+- `README.md` install instructions if the package name changes (e.g. you
+  publish under a different scope).
+- The `DEFAULT_BASE_URL` constant in `src/client.ts` if you intend to talk to
+  a non-default MANTYX deployment.
+
+## What stays the same
+
+- The wire protocol the SDK speaks (`docs/agent-runs-protocol.md`).
+- The `MantyxClient` API surface.
+- The example projects.
+- Tests and the mock server (zero MANTYX dependencies).
+
+That's it. The extracted package can be built, tested, and published from
+any environment with Node.js 18.17+ installed.

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 MANTYX
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,304 @@
+# @mantyx/sdk
+
+The official TypeScript SDK for the [MANTYX](https://mantyx.com) agent
+runtime. Define ephemeral agents that mix server-side MANTYX tools with
+locally-executed tools, run them remotely, and stream events back into your
+process.
+
+- LLM loop runs on MANTYX (BYOK or platform-hosted models).
+- Server-side tools (`mantyx`, `mantyx_plugin`) execute inside MANTYX.
+- Local tools execute inside *your* process; the SDK shuttles inputs and
+  outputs over an SSE stream + a tool-result POST.
+- One-shot runs and multi-turn sessions, both with persisted observability.
+- Authenticated with a single workspace API key.
+
+For background, see the [agent-runs protocol spec](./docs/agent-runs-protocol.md).
+
+## Install
+
+```bash
+npm install @mantyx/sdk zod
+# or: pnpm add @mantyx/sdk zod
+# or: yarn add @mantyx/sdk zod
+```
+
+Requires Node.js 18.17+ (for `fetch` and `ReadableStream`). `zod` is the only
+runtime dependency the SDK adds; the rest is the standard library and your
+own modules.
+
+## Quickstart
+
+```ts
+import { z } from "zod";
+import fs from "node:fs/promises";
+import { MantyxClient, defineLocalTool, mantyxTool } from "@mantyx/sdk";
+
+const client = new MantyxClient({
+  apiKey: process.env.MANTYX_API_KEY!,
+  workspaceSlug: process.env.MANTYX_WORKSPACE_SLUG!,
+  // baseUrl: "https://api.mantyx.com", // override for self-hosted
+});
+
+const result = await client.runAgent({
+  systemPrompt: "You are a helpful assistant.",
+  prompt: "Read /etc/hostname and summarize what it says.",
+  tools: [
+    // Local tool — defined and executed in this process.
+    defineLocalTool({
+      name: "read_file",
+      description: "Read a file from the local filesystem.",
+      parameters: z.object({ path: z.string() }),
+      execute: async ({ path }) => fs.readFile(path, "utf8"),
+    }),
+    // Reference to an existing MANTYX workspace tool.
+    mantyxTool("tool_cm6abc123"),
+  ],
+});
+
+console.log(result.text);
+```
+
+The SDK opens an SSE stream to MANTYX, listens for `local_tool_call` events,
+runs the matching local handler, and POSTs the result back. The server keeps
+running the agent loop until it produces a final reply.
+
+## Triggering a persisted MANTYX agent
+
+Pass `agentId` to run an agent that already exists in your workspace. The
+server hydrates the agent's system prompt, model, and server-side tools
+(memory, skills, plugin tools, …) from the `Agent` row at run time. Anything
+you pass in `tools` is **merged on top** — typically `local` tools you want
+the agent to be able to call back into for this specific run.
+
+```ts
+import { defineLocalTool, MantyxClient } from "@mantyx/sdk";
+import { z } from "zod";
+
+const client = new MantyxClient({ apiKey: "...", workspaceSlug: "acme" });
+
+const result = await client.runAgent({
+  agentId: "agent_cm6abc123", // workspace agent id
+  prompt: "Pull the latest deploy logs and summarise them.",
+  tools: [
+    defineLocalTool({
+      name: "read_local_file",
+      parameters: z.object({ path: z.string() }),
+      execute: ({ path }) => readFileSync(path, "utf8"),
+    }),
+  ],
+});
+console.log(result.text);
+```
+
+Notes:
+
+- `systemPrompt` becomes optional when `agentId` is set; if both are sent,
+  the agent's stored prompt wins.
+- `modelId` is also optional: omit it to use the agent's configured LLM
+  provider, or pass it to override the model for this run.
+- The API key must be authorized for the agent (an empty `agentIds` allowlist
+  on the key counts as "all agents in the workspace"). Otherwise the call
+  returns `403`.
+
+The same `agentId` field works on `client.createSession({ ... })` for
+multi-turn conversations against a persisted agent.
+
+## Picking a model
+
+```ts
+const { models, defaultModelId } = await client.listModels();
+console.log(models.map((m) => `${m.id}\t${m.label}`).join("\n"));
+
+await client.runAgent({
+  systemPrompt: "...",
+  prompt: "Hi!",
+  modelId: "platform:cm6abc123", // or "provider:<id>", or "<vendorModelId>"
+});
+```
+
+`modelId` accepts:
+
+- `platform:<offeringId>` — a platform-hosted model offering.
+- `provider:<llmProviderId>` — your own BYOK provider's default model.
+- `provider:<llmProviderId>:<vendorModelId>` — your provider, override model.
+- `<vendorModelId>` — bare vendor id; only resolves when one workspace
+  provider can run it.
+- omitted — workspace default.
+
+## Streaming tokens
+
+```ts
+for await (const event of client.streamAgent({
+  systemPrompt: "...",
+  prompt: "Tell me a story.",
+})) {
+  if (event.type === "assistant_delta") process.stdout.write(event.text);
+  if (event.type === "result") process.stdout.write("\n");
+}
+```
+
+Or use the `onAssistantDelta` callback on `runAgent`:
+
+```ts
+await client.runAgent({
+  systemPrompt: "...",
+  prompt: "...",
+  onAssistantDelta: (delta) => process.stdout.write(delta),
+});
+```
+
+## Multi-turn sessions
+
+Sessions own the agent spec (system prompt, model, tool defs) and the full
+message history. Each `send` is a run scoped to the session.
+
+```ts
+const session = await client.createSession({
+  systemPrompt: "You are a friendly REPL.",
+  tools: [
+    defineLocalTool({
+      name: "today",
+      description: "Get today's date as ISO 8601.",
+      parameters: z.object({}),
+      execute: () => new Date().toISOString().slice(0, 10),
+    }),
+  ],
+});
+
+const r1 = await session.send("What day is it?");
+console.log(r1.text);
+
+const r2 = await session.send("And what about tomorrow?");
+console.log(r2.text);
+
+await session.end();
+```
+
+### Tagging runs and sessions with `metadata`
+
+Attach a flat string→string KV to runs and sessions so your team can filter
+the dashboard by it (Agent runs → "Metadata" filter):
+
+```ts
+// One-shot run
+await client.runAgent({
+  systemPrompt: "...",
+  prompt: "...",
+  metadata: { customer: "acme", env: "prod", workflow: "support_triage" },
+});
+
+// Session — every run created via `session.send` inherits these tags
+const session = await client.createSession({
+  systemPrompt: "...",
+  metadata: { customer: "acme", env: "prod" },
+});
+
+// Per-message override; merged on top of the session's metadata
+// (run-level keys win)
+await session.send("trace this turn", {
+  metadata: { trace_id: "trace_abc" },
+});
+```
+
+Limits enforced server-side: max 16 entries; keys match `[A-Za-z0-9._-]{1,64}`;
+values are strings ≤ 256 chars; serialized JSON ≤ 4 KB. Bigger payloads return
+`400 invalid_request`.
+
+Resuming a session from a different process re-binds your local tool
+handlers; pass them in via `resumeSession`:
+
+```ts
+const session = await client.resumeSession(sessionId, {
+  tools: [
+    defineLocalTool({
+      name: "today",
+      description: "Get today's date as ISO 8601.",
+      parameters: z.object({}),
+      execute: () => new Date().toISOString().slice(0, 10),
+    }),
+  ],
+});
+```
+
+## API reference
+
+### `new MantyxClient(options)`
+
+```ts
+interface MantyxClientOptions {
+  apiKey: string;
+  workspaceSlug: string;
+  baseUrl?: string;       // default: https://api.mantyx.com
+  fetch?: typeof fetch;
+  timeoutMs?: number;     // default: 60_000
+}
+```
+
+### Methods
+
+| Method                                        | Returns                              |
+| --------------------------------------------- | ------------------------------------ |
+| `listModels()`                                | `Promise<ModelCatalog>`              |
+| `runAgent(spec)`                              | `Promise<RunResult>`                 |
+| `streamAgent(spec)`                           | `AsyncIterable<RunEvent>`            |
+| `createSession(spec)`                         | `Promise<AgentSession>`              |
+| `resumeSession(sessionId, { tools? })`        | `Promise<AgentSession>`              |
+| `endSession(sessionId)`                       | `Promise<void>`                      |
+| `cancelRun(runId)`                            | `Promise<void>`                      |
+
+### Tools
+
+| Helper                     | Use case                                                     |
+| -------------------------- | ------------------------------------------------------------ |
+| `defineLocalTool(opts)`    | Define a local tool with a Zod parameter schema and handler. |
+| `mantyxTool(id)`           | Reference an existing MANTYX tool by id.                     |
+| `mantyxPluginTool(name)`   | Reference an installed platform plugin tool by name.         |
+
+### Errors
+
+All thrown errors extend `MantyxError`. Common subclasses:
+
+- `MantyxAuthError` — 401/403 from the server (bad API key, wrong workspace).
+- `MantyxNetworkError` — transport-layer failures.
+- `MantyxRunError` — the agent loop terminated with an error.
+- `MantyxToolError` — a local tool handler threw or timed out.
+
+## Examples
+
+Self-contained example projects live under [`examples/`](./examples/):
+
+- `examples/oneshot-local-tool` — minimal one-shot run with a local tool.
+- `examples/session-chat` — interactive REPL on top of a session.
+- `examples/mixed-tools` — combines local, MANTYX, and plugin tools.
+- `examples/streaming` — token streaming to stdout.
+- `examples/list-models` — model catalog + pick-and-run.
+
+Each example is its own project (`package.json`, `tsconfig.json`, `README.md`)
+so you can copy any one of them out of the repo and run it standalone.
+
+## Wire protocol
+
+This SDK is a thin client over a stable HTTP/SSE protocol. The full
+specification ships with the package at
+[`docs/agent-runs-protocol.md`](./docs/agent-runs-protocol.md). Anyone can
+implement a compatible client in another language.
+
+## Development
+
+```bash
+pnpm install
+pnpm test          # unit + mock-server tests
+pnpm typecheck
+pnpm build         # emits dist/ (ESM + CJS + d.ts)
+```
+
+The SDK has zero internal `workspace:*` dependencies. `pnpm build` produces a
+self-contained `dist/` ready for `npm publish`.
+
+See [`CONTRIBUTING.md`](./CONTRIBUTING.md) for the contribution flow and
+[`EXTRACT.md`](./EXTRACT.md) for the (very small) steps to lift this folder
+into its own public repository.
+
+## License
+
+[Apache-2.0](./LICENSE)