@loomcycle/client 1.12.1 → 1.13.0

package/README.md

@@ -12,6 +12,7 @@ TypeScript client for the [loomcycle](https://github.com/denn-gubsky/loomcycle)
 
 ### What's new since v0.8.18
 
+- **Breaking — `tools` replaces `allowedTools`** — the per-run tool allowlist is now a single canonical key. The `runStreaming` / `continueSession` option is renamed from `allowedTools` to **`tools`**, and the `AgentDefOverlay` + library wire field is likewise **`tools`**, matching the loomcycle YAML rename and aligning with Claude Code agent frontmatter. No dual-key fallback — update call sites to `runStreaming({ …, tools: [...] })`. Requires a loomcycle server carrying the same rename.
 - **Path/Document browse-by-subject + the full Document op set** (v1.12.1, RFC AS/AK) — `path(input, opts)` and `document(input, opts)` accept optional `scopeId` / `tenant` browse overrides, sent as `?scope_id=` / `?tenant=` query params (the server reads them from the URL and re-checks authorization — a tenant principal's `tenant` is ignored, `scopeId` picks any subject it may see); omit both to browse your own subject (byte-identical to the pre-RFC-AS request). `DocumentToolInput.op` now covers all 16 backend ops — adds **`set_path`** (attach/re-home a Path-tree name for an existing document), **`export_md`** (render to Markdown; `include_metadata: false` for clean human-facing output), and **`import_md`** (build a document from export_md-shaped `markdown`). Additive — existing `path()` / `document()` callers are unchanged.
 - **`interactiveSession` / `sendRunInput` / `streamRunByID` + the `interactive` flag** (v1.1.1, RFC AI) — the interactive agentic session, the adapter port of the Web UI's run terminal. Pass `interactive: true` to `runStreaming` / `continueSession` to start a **persistent** run that parks at end_turn (an `awaiting_input` frame) instead of ending; **`sendRunInput(runId, text)`** steers it (the response arrives on the same stream); **`streamRunByID(runId, {fromSeq})`** re-attaches by run_id (the operator's prior turns replay as `steer` events, `user_input.source === "replay"`, so a cold client — e.g. another device — reconstructs the whole conversation). The high-level **`client.interactiveSession({agent, segments})`** returns an `InteractiveSession` with `events()` / `send()` / `cancel()`; **`attachInteractiveSession(runId)`** resumes one. The `AgentEvent` union gains `awaiting_input` / `steer` / `context_compaction`.
 - **`volumeDef` / `listVolumes` / `listEphemeralVolumes`** (v0.35.0, RFC AH) — the dynamic filesystem-volume surface. `volumeDef` is the op-discriminated substrate tool (`create` / `get` / `list` / `delete` / `purge`); a Volume is **flat** (a pointer to mutable on-disk state, not a versioned def), so `delete` unmaps + leaves files while `purge` removes the row **and** the directory tree — there is no retire/promote/fork. Tenant-confined (`ScopeTenant`): the runtime derives the path inside an operator-blessed `dynamic_root`, so you pass `{name, mode}`, never a host path. `listVolumes()` / `listEphemeralVolumes()` return the tenant's persistent + live run-scoped volumes; host paths are redacted (`""`) for a non-operator caller.
@@ -412,8 +413,8 @@ The stream stays open for up to 30 minutes (server-enforced); reconnect on close
 - `matches: true` only when both hashes are non-empty AND equal. An empty caller hash NEVER matches (no false-positive when the deployed row's hash is also empty due to a not-yet-completed backfill).
 - `deployed: false` ⇒ `matches: false`. Use this to distinguish "no active row" (first deploy) from "drift" (push update).
 - The CLI hash and the substrate's hash are guaranteed identical for matching content — both compute through the same Go function in `internal/agents.Sign`.
-- Agent hash covers `name + description + system_prompt + allowed_tools + skills + model + provider + tier + effort + max_tokens + max_iterations + providers + models + memory_scopes + memory_quota_bytes`. Explicitly excluded: `def_id`, `version`, `created_at`, `retired`, **plus** `channels` and `*_scopes` (operator-yaml-only ACL fields that don't round-trip through `set` / `fork`).
-- Skill hash covers `name + description + body + allowed_tools`. Skill bodies are normalised before hashing (CRLF → LF; trailing whitespace stripped) so editor drift doesn't cause spurious mismatches.
+- Agent hash covers `name + description + system_prompt + tools + skills + model + provider + tier + effort + max_tokens + max_iterations + providers + models + memory_scopes + memory_quota_bytes`. Explicitly excluded: `def_id`, `version`, `created_at`, `retired`, **plus** `channels` and `*_scopes` (operator-yaml-only ACL fields that don't round-trip through `set` / `fork`).
+- Skill hash covers `name + description + body + tools`. Skill bodies are normalised before hashing (CRLF → LF; trailing whitespace stripped) so editor drift doesn't cause spurious mismatches.
 
 See `help(topic="content-signatures")` from inside an agent run for the full operator narrative.
 

package/dist/cjs/client.js

@@ -77,8 +77,8 @@ function runBody(opts) {
         agent: opts.agent,
         segments: opts.segments,
     };
-    if (opts.allowedTools !== undefined)
-        body.allowed_tools = opts.allowedTools;
+    if (opts.tools !== undefined)
+        body.tools = opts.tools;
     if (opts.allowedHosts !== undefined && opts.allowedHosts !== null) {
         body.allowed_hosts = opts.allowedHosts;
     }
@@ -167,8 +167,8 @@ class LoomcycleClient {
         const body = {
             segments: opts.segments,
         };
-        if (opts.allowedTools !== undefined)
-            body.allowed_tools = opts.allowedTools;
+        if (opts.tools !== undefined)
+            body.tools = opts.tools;
         if (opts.allowedHosts !== undefined && opts.allowedHosts !== null) {
             body.allowed_hosts = opts.allowedHosts;
         }
@@ -635,8 +635,8 @@ class LoomcycleClient {
      *  stable and dedup engages on re-register. */
     async ensureCodeAgent(opts, callOpts) {
         const overlay = { provider: "code-js", code_body: opts.code };
-        if (opts.allowedTools)
-            overlay.allowed_tools = opts.allowedTools;
+        if (opts.tools)
+            overlay.tools = opts.tools;
         if (opts.tier)
             overlay.tier = opts.tier;
         if (opts.model)
@@ -662,7 +662,7 @@ class LoomcycleClient {
     /** Invoke the v0.9.x MCPServerDef substrate tool over HTTP.
      *  Dynamic MCP server registration — register an HTTP /
      *  Streamable-HTTP MCP server at runtime so its tools become
-     *  callable from any agent's `allowed_tools` list without a yaml
+     *  callable from any agent's `tools` list without a yaml
      *  edit + restart.
      *
      *  Operator-admin-only: this endpoint requires the bearer token.

package/dist/client.d.ts

@@ -419,7 +419,7 @@ export declare class LoomcycleClient {
     /** Invoke the v0.9.x MCPServerDef substrate tool over HTTP.
      *  Dynamic MCP server registration — register an HTTP /
      *  Streamable-HTTP MCP server at runtime so its tools become
-     *  callable from any agent's `allowed_tools` list without a yaml
+     *  callable from any agent's `tools` list without a yaml
      *  edit + restart.
      *
      *  Operator-admin-only: this endpoint requires the bearer token.

package/dist/client.js

@@ -74,8 +74,8 @@ function runBody(opts) {
         agent: opts.agent,
         segments: opts.segments,
     };
-    if (opts.allowedTools !== undefined)
-        body.allowed_tools = opts.allowedTools;
+    if (opts.tools !== undefined)
+        body.tools = opts.tools;
     if (opts.allowedHosts !== undefined && opts.allowedHosts !== null) {
         body.allowed_hosts = opts.allowedHosts;
     }
@@ -164,8 +164,8 @@ export class LoomcycleClient {
         const body = {
             segments: opts.segments,
         };
-        if (opts.allowedTools !== undefined)
-            body.allowed_tools = opts.allowedTools;
+        if (opts.tools !== undefined)
+            body.tools = opts.tools;
         if (opts.allowedHosts !== undefined && opts.allowedHosts !== null) {
             body.allowed_hosts = opts.allowedHosts;
         }
@@ -632,8 +632,8 @@ export class LoomcycleClient {
      *  stable and dedup engages on re-register. */
     async ensureCodeAgent(opts, callOpts) {
         const overlay = { provider: "code-js", code_body: opts.code };
-        if (opts.allowedTools)
-            overlay.allowed_tools = opts.allowedTools;
+        if (opts.tools)
+            overlay.tools = opts.tools;
         if (opts.tier)
             overlay.tier = opts.tier;
         if (opts.model)
@@ -659,7 +659,7 @@ export class LoomcycleClient {
     /** Invoke the v0.9.x MCPServerDef substrate tool over HTTP.
      *  Dynamic MCP server registration — register an HTTP /
      *  Streamable-HTTP MCP server at runtime so its tools become
-     *  callable from any agent's `allowed_tools` list without a yaml
+     *  callable from any agent's `tools` list without a yaml
      *  edit + restart.
      *
      *  Operator-admin-only: this endpoint requires the bearer token.

package/dist/types.d.ts

@@ -138,7 +138,7 @@ export interface PromptSegment {
 export interface RunOptions {
     agent: string;
     segments: PromptSegment[];
-    allowedTools?: string[];
+    tools?: string[];
     /** Per-request URL allowlist (v0.3.3+). Three-state on the wire:
      *  - omitted / `undefined` — no narrowing (operator's static list applies).
      *  - `null` — same as omitted (pass-through; convenience for callers
@@ -288,7 +288,7 @@ export interface ContinueOptions {
     /** Required — the session to continue. */
     sessionId: string;
     segments: PromptSegment[];
-    allowedTools?: string[];
+    tools?: string[];
     /** Per-call URL allowlist. Same three-state semantics as
      *  RunOptions.allowedHosts — continuations re-supply the list each
      *  time rather than inheriting from the seed run. */
@@ -1262,7 +1262,7 @@ export interface AgentDefVerifyResult {
 }
 /** Response shape for `SkillDef verify`. Same semantics as
  *  AgentDefVerifyResult; the per-skill content basis is just
- *  smaller (name + description + body + allowed_tools). */
+ *  smaller (name + description + body + tools). */
 export interface SkillDefVerifyResult {
     matches: boolean;
     current_sha256: string;
@@ -1375,7 +1375,7 @@ export interface AgentDefOverlay {
     max_iterations?: number;
     max_concurrent_children?: number;
     system_prompt?: string;
-    allowed_tools?: string[];
+    tools?: string[];
     skills?: string[];
     memory_scopes?: string[];
     memory_quota_bytes?: number;
@@ -1400,8 +1400,8 @@ export interface EnsureCodeAgentOptions {
      *  is stable across restarts — that's what lets loomcycle dedup the
      *  re-registration. */
     code: string;
-    /** The agent's allowed_tools ceiling (must be a subset of the caller's). */
-    allowedTools?: string[];
+    /** The agent's tools ceiling (must be a subset of the caller's). */
+    tools?: string[];
     /** Per-user tier policy name (mutually exclusive with `model` in practice). */
     tier?: string;
     /** Pin a concrete model id (overrides tier resolution). */
@@ -1445,7 +1445,7 @@ export interface LibraryAgentDefinition {
     max_iterations?: number;
     system_prompt?: string;
     system_prompt_base?: string;
-    allowed_tools?: string[];
+    tools?: string[];
     skills?: string[];
     providers?: string[];
     /** Per-tier candidate list. Server-side opaque shape — kept as
@@ -1458,12 +1458,12 @@ export interface LibraryAgentDefinition {
 export interface LibrarySkillDefinition {
     body?: string;
     description?: string;
-    allowed_tools?: string[];
+    tools?: string[];
 }
 /** Static-side MCP server definition body. Mirrors
  *  internal/api/http.marshalStaticMCPServer (transport + url + headers
  *  for http/streamable-http; command/args/env/pool_size for stdio;
- *  allowed_tools narrowing; discovered_tools cached from the pool
+ *  tools narrowing; discovered_tools cached from the pool
  *  inspector when ready). */
 export interface LibraryMcpServerDefinition {
     transport?: "http" | "streamable-http" | "stdio";
@@ -1473,7 +1473,7 @@ export interface LibraryMcpServerDefinition {
     args?: string[];
     env?: Record<string, string>;
     pool_size?: number;
-    allowed_tools?: string[];
+    tools?: string[];
     /** Substrate-mirror shape of the pool's PeekTools snapshot.
      *  Omitted when the pool inspector returns nil (init pending or
      *  failed) — re-check after pool init completes. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@loomcycle/client",
-  "version": "1.12.1",
+  "version": "1.13.0",
   "description": "TypeScript client for the loomcycle sidecar (HTTP+SSE). 63 methods covering run streaming, agent metadata, pause/resume/state, resolver re-probe (resolveProbe — issue #88 operator escape hatch), operator-token admin (operatorTokenDef — RFC L OSS multi-tenant auth) + whoami (RFC L authoritative principal, v0.17.0) + tenant-scoped listUsers / listUserAgents, dynamic MCP registration (mcpServerDef + v0.18.0 typed mcpServerDefVerify + ensureMcpServer idempotent register-if-changed), snapshot lifecycle, memory admin (incl. v0.9.0 Vector Memory embed_stats + reembed AND v0.11.5 setMemoryEntry + deleteMemoryEntry), interruption resolve, hook management, v0.8.22 substrate admin (agentDef + skillDef), v0.9.x n8n Phase 0 (listChannels + streamUserRunStates), v0.9.x Channel CRUD (publishChannel + subscribeChannel + peekChannel + ackChannel), v0.11.5 Channel admin CRUD (createChannel + updateChannel + deleteChannel — runtime substrate; yaml channels refuse mutation with HTTP 409), v0.9.x content_sha256 verify, v0.9.1 transcript first-cycle, v0.9.x dynamic MCP server registration (mcpServerDef + MCPServerDefVerifyResult), v0.10.3 Library v2 enumeration (listLibraryAgents + listLibrarySkills + listLibraryMcpServers), and v0.11.0 LLM Gateway (llmChat + llmStream — direct provider routing without agent overhead; primary target is n8n's LoomCycleChatModel AI Agent sub-node and any LangChain-compatible consumer). v0.10.1 — dual ESM + CommonJS distribution (additive — ESM consumers unchanged; CJS consumers like n8n's community-node loader now work). v0.19.0 — typed inline code-js agent ingestion (AgentDefOverlay.code_body + ensureCodeAgent — register a deterministic code agent through the substrate with no host filesystem bind; RFC J). v0.20.0 — ensureMcpServer surfaces discoveredToolCount straight from create (loomcycle now auto-discovers MCP tools at ingestion); rediscover is now an explicit force-refresh. v0.21.0 — run/continue accept optional non-secret `metadata` (repo name, review policy, …) passed to the agent, symmetric with the WebHook/Schedule trigger paths. v0.22.0 — version-aligned lockstep release; no client-surface change (RFC N tenant isolation of the agent/skill/MCP/Schedule/Webhook definition plane + real op-schemas on the builtin MCP meta-tools are both server-side). v0.23.0 — version-aligned lockstep release; no client-surface change (RFCs O/P/R MCP-server hardening + thin client and the RFC Q DeepSeek tool-content fix are all server-side / MCP-transport-side). v0.24.0 — purgeChannel clears a channel's buffered messages without deleting its definition (allowed on yaml-declared channels too, unlike deleteChannel — F20); AgentDefOverlay gains channels / evaluation_scopes / interruption so a COMPLETE interactive/multi-agent agent round-trips over the substrate (F14). (Consolidates the interim 0.24/0.25 package bumps, which were never tag-published, back into lockstep with the loomcycle v0.24.0 tag.) v0.25.0 — adds the RFC S channel fan-in/fan-out client twins: awaitChannels() (wait for any/all/at_least N messages across channels, or a timeout — non-committing) + broadcastChannels() (publish one payload to N channels in one atomic-pre-flight call), the client-facing counterparts of the in-band Channel.await / Channel.broadcast tool ops (the rest of v0.25.0 — the manual-management Web UI console + Context op=time + max_fires self-retiring schedules — is server-side / in-band, no client-surface change). v0.29.1 — Usage gains optional `max_context_tokens` (the serving model's context-window ceiling, stamped by the loop from Provider.Capabilities() on each usage event) so a consumer can render a 'context used / max' gauge without a hard-coded per-model table; additive + optional, no behavior change. (Lockstep catch-up: the field landed in loomcycle v0.29.0 but the adapter publish skipped on a version mismatch; v0.29.1 realigns the package version with the release tag so it publishes.) v0.33.0 — gRPC + TS client parity for the RFC Y external fan-out and the compaction surface: spawnRunBatch() (POST /v1/runs:batch — spawn up to 32 fresh runs concurrently in one call, combined index-aligned envelope, per-child failures in-envelope) + compactRun(runId) (POST /v1/runs/{run_id}/compact — summarize a parked run's context); plus per-run sampling + compaction overrides now accepted on runStreaming / continueSession (an explicit temperature 0 is preserved as deterministic, not dropped as falsy). (The gRPC half adds the matching SpawnRunBatch / CompactRun RPCs + the sampling/compaction fields on RunRequest/ContinueRequest — server-side.) v0.34.0 — version-aligned lockstep release; no client-surface change (context-transform plugins / RFC Z Phase 1a are server-side config; the exp7 hardening pass is server-side; the R2 cross-provider thinking-model downgrade surfaces a new `model_downgraded` SSE event the generic stream passes through unchanged). v0.35.0 — RFC AH dynamic filesystem volumes: volumeDef() (POST /v1/_volumedef — op-discriminated create/get/list/delete/purge; a Volume is flat, so delete unmaps + purge RemoveAll's, no retire/promote/fork) + listVolumes() / listEphemeralVolumes() (GET /v1/_volumes[/ephemeral] — tenant-scoped; host paths redacted for non-operator callers). Tenant-confined; the runtime derives the path inside an operator-blessed dynamic_root, so callers pass name + mode, never a host path. v1.1.1 — RFC AI interactive agentic sessions: an `interactive: true` flag on runStreaming/continueSession (a run that parks at end_turn for steering) + sendRunInput(runId, text) (POST /v1/runs/{id}/input — steer a live run) + streamRunByID(runId, {fromSeq}) (GET /v1/runs/{id}/stream — re-attach by run_id; the operator's prior turns replay as `steer` events so a cold client reconstructs the whole conversation) + a high-level InteractiveSession driver (client.interactiveSession / attachInteractiveSession — events()/send()/cancel(), the adapter port of the Web UI run terminal). The AgentEvent union gains awaiting_input/steer/context_compaction frames. Version-aligned with the loomcycle v1.1.x line so the v1.1.1 tag publishes it (also carrying the previously-unpublished v0.35.0 volume surface). v1.4.0 — RFC AL Path VFS + RFC AK Document on the wire: path(input) (POST /v1/_path — a Unix-like filesystem over Memory/Volumes/Documents; resolve/ls/stat/mkdir/mv/rm) + document(input) (POST /v1/_document — chunked-graph documents; 13 ops, needs SQL Memory on the sidecar). Scope (agent/user/tenant) + tenant are resolved server-side from the authenticated principal, never the wire; an off-run scope:'user' op keys on the principal subject so it interoperates with that user's agent runs. New PathToolInput / DocumentToolInput types; responses are op-varying (unknown — narrow as needed). v1.7.0 — RFC AT image/vision input: the PromptContent union gains an `image` variant ({ type:'image'; media_type: ImageMediaType; data: base64-no-prefix }) accepted in a user segment by runStreaming / continueSession (segments pass through unchanged — no method change). The model must be vision-capable or the run errors before the call. New ImageMediaType type (image/png|jpeg|gif|webp). v1.12.1 — Path/Document browse-by-subject + the full Document op set (RFC AS/AK): path(input, opts) / document(input, opts) accept optional scopeId / tenant browse overrides sent as ?scope_id= / ?tenant= query params (server reads them from the URL, re-checks authorization; omit both to browse your own subject — byte-identical to the pre-RFC-AS request), and DocumentToolInput.op now covers all 16 backend ops (adds set_path, export_md, import_md) with the matching include_metadata / markdown fields. Additive — existing path() / document() callers are unchanged.",
   "license": "Apache-2.0",
   "type": "module",