@cuylabs/agent-server 0.10.0

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 reasonable and customary use in 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 [yyyy] [name of copyright owner]
+
+   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,262 @@
+# @cuylabs/agent-server
+
+Local session-and-turn host for `@cuylabs/agent-core`, with in-process, stdio, and websocket clients.
+
+See [docs/README.md](./docs/README.md) for the modular package docs.
+
+This package adds an interactive host layer above the existing framework packages:
+
+- `@cuylabs/agent-core` still owns agent execution, tools, sessions, and plugins
+- `@cuylabs/agent-runtime` still owns background scheduling/orchestration
+- `@cuylabs/agent-runtime-dapr` still owns Dapr durability and workflow hosting
+- `@cuylabs/agent-server` owns local multi-session turn execution, live event fanout, and client-facing session APIs
+
+## Boundary
+
+Use `@cuylabs/agent-server` when you want a long-lived local process to:
+
+- manage multiple persisted sessions
+- start and interrupt turns independently of a single UI client
+- stream `AgentEvent`s to multiple subscribers
+- let clients disconnect and reconnect without losing server-owned turn state
+
+This package is intentionally **not**:
+
+- a replacement for `agent-runtime` or `agent-runtime-dapr`
+- a new plugin system
+- a renderer/UI extension layer
+
+The current implementation ships three access patterns:
+
+- in-process client/server for the CLI and tests
+- stdio transport for one external client process
+- websocket transport for reconnectable multi-client use
+
+## Capability contract
+
+`@cuylabs/agent-server` now exposes an explicit capability snapshot through
+`getCapabilities()`.
+
+That contract is split into:
+
+- `protocol`
+  - transport kind, reconnect semantics, multi-client support
+- `sessions`
+  - persistence and session management features such as branching
+- `turns`
+  - streaming, waiting, interruption, steering, follow-up queuing, follow-up management, and concurrency rules
+- `interactive`
+  - approval request and human input request routing
+- `runtime`
+  - whether execution is local, remote, or hybrid
+  - whether orchestration is direct, `agent-runtime`, or `agent-runtime-dapr`
+  - whether Dapr-backed workflow delegation is available
+- `agent`
+  - workspace summary snapshots for startup and welcome surfaces
+  - model inspection and model switching
+  - tool, skill, and sub-agent profile inspection
+  - session runtime status snapshots for model/session/context state
+  - context compaction plus turn undo / diff helpers
+- `plugins`
+  - the server-side plugin contract: headless behavior, command metadata, no client extension execution
+
+This keeps the server/client boundary inspectable without coupling clients to implementation details.
+
+## What this enables
+
+`@cuylabs/agent-server` is useful when one agent session should outlive one UI process.
+
+It gives us a place to:
+
+- keep a turn running even if one TUI client disconnects
+- let multiple clients observe the same live session
+- expose session read/list/branch APIs without booting a fresh UI-owned loop
+- share one backend between TUI, automation, and future web or chat clients
+- keep plugin and tool execution on the server side while clients focus on rendering and input
+- expose steering and approval-request flows through a stable protocol instead of tying them to one UI
+
+## Core model
+
+This package uses the framework's own vocabulary instead of copying another tool's protocol:
+
+- **session** — the persisted tree-backed conversation in `agent-core` storage
+- **turn** — one user input plus the streamed agent work that follows
+- **event** — the raw `AgentEvent` emitted during a turn
+
+That matches the current framework better than introducing a second conversation model.
+
+## Quick start
+
+```ts
+import { createAgent } from "@cuylabs/agent-core";
+import {
+  InProcessAgentServer,
+  InProcessAgentServerClient,
+  createAgentServerAdapter,
+} from "@cuylabs/agent-server";
+
+const agent = createAgent({
+  model,
+  cwd: process.cwd(),
+  systemPrompt: "You are a helpful coding agent.",
+});
+
+const server = new InProcessAgentServer(createAgentServerAdapter(agent));
+const client = new InProcessAgentServerClient(server);
+
+const session = await client.createSession({ title: "Refactor auth flow" });
+const turn = await client.startTurn(session.id, "Find the auth bug and fix it.");
+
+const off = client.subscribe((notification) => {
+  if (notification.type === "turn/event") {
+    console.log(notification.event.type);
+  }
+}, { turnId: turn.id });
+
+const completed = await client.waitForTurn(turn.id);
+off();
+
+console.log(client.getCapabilities().runtime);
+console.log(completed.status, completed.output);
+```
+
+## Transport examples
+
+### WebSocket server
+
+```ts
+import {
+  InProcessAgentServer,
+  createAgentServerAdapter,
+  startAgentServerWebSocketServer,
+} from "@cuylabs/agent-server";
+
+const server = new InProcessAgentServer(createAgentServerAdapter(agent));
+const transport = startAgentServerWebSocketServer(server, {
+  host: "127.0.0.1",
+  port: 4647,
+});
+
+await transport.ready;
+console.error(`listening on ${transport.address()}`);
+```
+
+### Remote stdio client
+
+```ts
+import { connectStdioAgentServerClient } from "@cuylabs/agent-server";
+
+const client = await connectStdioAgentServerClient({
+  command: process.execPath,
+  args: ["./bin/cuylabs.js", "server", "--transport", "stdio"],
+});
+```
+
+## Human Input
+
+Direct `agent-core` human input now plugs into `agent-server` automatically
+when the agent is configured with both:
+
+- `humanInput` on `createAgent(...)`
+- at least one human-input tool such as `createHumanInputTool()`
+
+Example:
+
+```ts
+import {
+  createAgent,
+  createHumanInputTool,
+} from "@cuylabs/agent-core";
+
+const agent = createAgent({
+  model,
+  humanInput: {},
+  tools: [createHumanInputTool()],
+});
+
+const adapter = createAgentServerAdapter(agent);
+```
+
+In that setup:
+
+- `getCapabilities().interactive.humanRequests` becomes `true`
+- `human-input-request` and `human-input-resolved` flow through turn events
+- `respondToInputRequest(..., { kind: "human", response })` resolves the
+  pending controller request
+
+This keeps direct server mode aligned with the durable Dapr semantics:
+
+- request state is authoritative
+- events are live notifications
+- explicit response APIs resume execution
+
+## Why this exists
+
+Without an app server, the CLI process usually owns the live turn:
+
+- UI starts the turn
+- UI consumes `agent.chat(...)`
+- UI dies, the live interaction dies
+
+With an app server:
+
+- server starts the turn
+- server owns session and turn state
+- server fans out updates to subscribers
+- clients can reconnect or multiple clients can observe the same session
+
+That is the key shift: the live agent loop stops belonging to one terminal window.
+
+## Plugins
+
+This package does not require a plugin API rewrite.
+
+`agent-core` plugins already contribute headless behavior:
+
+- tools
+- middleware
+- host commands
+- prompt sections
+- lifecycle hooks
+
+That logic stays on the server side. The app server executes the same agent, so plugin business logic continues to run where it already belongs.
+
+Server-backed hosts can now also discover and execute plugin commands through the same `agent-server` contract:
+
+- `listPluginCommands()`
+- `executePluginCommand(name, args)`
+
+That keeps plugin command routing attached to the hosted agent instead of duplicating command execution logic in every client.
+
+If you later add client-specific UI extensions, that should be a **separate** client-layer extension surface. Do not mix TUI/web UI contributions into the server plugin contract.
+
+## Relationship to Dapr
+
+`agent-runtime-dapr` and `agent-server` solve different problems:
+
+- Dapr gives durable workflows, checkpoints, state stores, and jobs
+- agent-server gives session/turn APIs, subscriptions, and live client semantics
+
+They compose well:
+
+- agent-server can start turns locally
+- some turns can be delegated to a durable runtime later while still presenting the same client-facing capability contract
+- the client-facing protocol stays the same
+
+## Current status
+
+The current package provides:
+
+- in-process session listing, reading, creation, deletion, and branching
+- background turn execution with `startTurn(...)`
+- per-turn interruption, steering, and follow-up queuing
+- follow-up management: list, get, resolve/discard queued follow-ups
+- approval request routing over server notifications
+- human input request routing over server notifications
+- multi-subscriber event fanout
+- `waitForTurn(...)` and turn inspection
+- capability-gated agent affordances such as runtime status, model switching, tool inventory, skill inspection, sub-agent profiles, compact, undo, and diff
+- workspace summary snapshots that let clients render startup state from the server instead of stitching local counters together
+- stdio and websocket transports for external clients
+
+The next layer is not “add a server.” The server already exists. The next layer is broader client adoption and richer request/response flows on top of the same ownership model.