@coder/ai-sdk-agent 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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,188 @@
+# @coder/ai-sdk-agent
+
+[![CI](https://github.com/coder/ai-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/coder/ai-sdk/actions/workflows/ci.yml)
+[![npm](https://img.shields.io/npm/v/@coder/ai-sdk-agent.svg)](https://www.npmjs.com/package/@coder/ai-sdk-agent)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE)
+
+A **Vercel AI SDK–compliant agent backed by Coder Agents** — Coder's server‑side
+agent runtime. Call `new CoderAgent(...)` and get back an object that implements the
+AI SDK's [`Agent`](https://ai-sdk.dev/docs/reference/ai-sdk-core/agent) interface
+(`generate()` / `stream()`). Script it, stream from it, and attach your own tools —
+exactly like the SDK's own `ToolLoopAgent`.
+
+> Status: works end‑to‑end against Coder's experimental chat API (`/api/experimental/chats`).
+> Both the Coder API and this package are pre‑1.0; expect change.
+
+## Why
+
+**Coder Agents** runs a complete agent loop **server‑side** — the multi‑step tool
+loop, built‑in tools, MCP, sub‑agents, multi‑provider model routing, and automatic
+context compaction. The Vercel AI SDK runs its loop **client‑side**. This package
+bridges the two, so a Coder agent looks and feels like a native AI SDK agent without
+re‑implementing the loop.
+
+## Install
+
+```bash
+pnpm add @coder/ai-sdk-agent ai zod
+```
+
+Requires Node ≥ 20 and `ai` v6.
+
+## Quick start
+
+```ts
+import { CoderAgent } from "@coder/ai-sdk-agent";
+import { tool } from "ai";
+import { z } from "zod";
+
+const agent = new CoderAgent({
+  baseUrl: "https://dev.coder.com",
+  token: process.env.CODER_SESSION_TOKEN!, // Coder API/session token
+  organizationId: "703f72a1-…", // your org UUID
+  model: "claude-sonnet-4-6", // hint: UUID, provider:model, model id, or display-name substring
+  instructions: "You are a helpful coding assistant.",
+  tools: {
+    getWeather: tool({
+      description: "Get the weather for a city.",
+      inputSchema: z.object({ city: z.string() }),
+      execute: async ({ city }) => ({ city, tempC: 21 }),
+    }),
+  },
+});
+
+// Non-streaming
+const { text, steps, usage } = await agent.generate({ prompt: "Weather in Paris?" });
+
+// Streaming
+const result = await agent.stream({ prompt: "Write a haiku about Coder." });
+for await (const delta of result.textStream) process.stdout.write(delta);
+```
+
+`generate()` returns a real AI SDK `GenerateTextResult`; `stream()` returns a real
+`StreamTextResult` (so `.textStream`, `.fullStream`, `.toUIMessageStream()`, `.steps`,
+`.usage`, etc. all work). Because `CoderAgent` _is_ an `Agent`, it composes with the rest
+of the AI SDK.
+
+## Examples
+
+Runnable scripts live in [`examples/`](./examples) (run against a real deployment via `tsx`):
+
+```bash
+export CODER_URL=https://dev.coder.com
+export CODER_SESSION_TOKEN=$(coder tokens create --name coderagent-example)
+
+pnpm example:generate     # non-streaming generate()
+pnpm example:stream       # streaming via textStream
+pnpm example:tool         # custom (client-executed) tool round-trip
+pnpm example:multi-turn   # multi-turn session memory
+```
+
+Each example creates a new chat and archives it when done — it never touches workspaces. See
+[`examples/README.md`](./examples/README.md) for details.
+
+## Custom tools
+
+Tools you pass are registered with Coder Agents as **client‑executed** ("dynamic") tools.
+When the model calls one, the run pauses on the server; the AI SDK runs your tool's
+`execute`, this package submits the result back, and the run resumes. This is the standard
+AI SDK tool loop — your `execute` runs in your process.
+
+- Give tools an `execute` for scripting use (the loop runs to completion automatically).
+- Coder's own server‑side tools (file editing, shell, MCP, …) still run on the server and
+  appear in the transcript as `providerExecuted` tool calls/results — you observe them, you
+  don't execute them.
+
+## Auth
+
+Pass a Coder **API token** or **session token** as `token`; it is sent as the
+`Coder-Session-Token` header (REST) and used to authenticate the streaming WebSocket. Create
+a token with `coder tokens create`, or reuse your CLI session.
+
+You can also pass a pre‑built client:
+
+```ts
+import { CoderAgent, CoderChatClient } from "@coder/ai-sdk-agent";
+const client = new CoderChatClient({ baseUrl, token });
+const agent = new CoderAgent({ client, organizationId });
+```
+
+## Sessions
+
+One `CoderAgent` instance maps to one chat ("session") on the Coder server. The chat is
+created on the first turn and reused for subsequent `generate()`/`stream()` calls (multi‑turn
+conversation with server‑side history). `agent.chatId` is the current chat id.
+
+- `agent.resetSession()` — start a fresh chat on the next turn.
+- `agent.interrupt()` — interrupt an in‑flight generation.
+- `agent.archive()` — archive the underlying chat (cleanup).
+- Resume a prior chat: `new CoderAgent({ …, chatId: "…" })`.
+
+A single instance is **single‑flight** — don't run concurrent generations against it.
+
+## Configuration
+
+`CoderAgentSettings`:
+
+| field                             | description                                                                   |
+| --------------------------------- | ----------------------------------------------------------------------------- |
+| `client` \| (`baseUrl` + `token`) | connection (one or the other)                                                 |
+| `organizationId`                  | org UUID that owns the chat (required)                                        |
+| `model`                           | model hint: UUID, `provider:model`, model id, or display‑name substring       |
+| `instructions`                    | system prompt                                                                 |
+| `tools`                           | AI SDK `ToolSet` (client‑executed)                                            |
+| `workspaceId`                     | bind the chat to a Coder workspace (enables workspace‑scoped tools)           |
+| `mcpServerIds`                    | server‑side MCP servers to enable                                             |
+| `planMode`                        | enable plan mode (`"plan"`)                                                   |
+| `stopWhen`                        | AI SDK stop condition(s); default `stepCountIs(64)`                           |
+| `maxRetries`                      | default `0` — SDK retries can duplicate server‑side turns; override with care |
+| `chatId`                          | resume an existing chat                                                       |
+
+## How it works
+
+```
+CoderAgent  (implements ai.Agent)
+  └─ ToolLoopAgent (ai)            ← inherits generate()/stream(), loop control
+       └─ CoderLanguageModel       ← implements @ai-sdk/provider LanguageModelV3
+            └─ CoderChatClient      ← REST + WebSocket to /api/experimental/chats
+                 └─ Coder Agents     ← runs the agent loop SERVER-side
+```
+
+- One `doStream` call advances the chat until it **settles** (`waiting`/`completed`) or
+  **pauses** for a client tool (`requires_action`). The SDK loop and the server‑side loop
+  mesh at the client‑tool boundary, so there's no double loop.
+- Streaming text is emitted from `message_part` deltas; fast turns that only produce a full
+  `message` snapshot are diffed against an emitted‑length cursor — so neither double‑counts.
+
+## Testing
+
+```bash
+pnpm test          # unit tests (hermetic, mocked client)
+pnpm typecheck
+pnpm lint          # lint with oxlint
+pnpm format        # format with oxfmt (or `pnpm format:check` to verify only)
+pnpm check         # format check + lint + typecheck (CI gate)
+pnpm build
+```
+
+End‑to‑end tests run against a live Coder deployment and are opt‑in via env:
+
+```bash
+CODER_URL=https://dev.coder.com \
+CODER_SESSION_TOKEN=$(coder tokens create --name e2e) \
+pnpm test:e2e
+```
+
+The e2e suite creates **new chats only** (no workspaces) and archives them afterward.
+
+## Limitations
+
+- The Coder chat API is experimental (`/api/experimental/chats`); wire types may change.
+- File/image **inputs** are not yet forwarded to the server (text prompts only).
+- Designed for Node (WebSocket via `ws`); a browser build can inject a `webSocketFactory`.
+- A v7 `@ai-sdk/harness` adapter (the conceptually exact fit) is a future direction once that
+  experimental API stabilizes.
+
+## License
+
+Apache-2.0