experimental-ash 0.55.2 → 0.56.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # experimental-ash
 
+## 0.56.0
+
+### Minor Changes
+
+- e5f2d97: Ship the root Ash skill packages inside the npm package under `dist/skills`. The docs site now renders those canonical `SKILL.md` files directly as skill reference pages, avoiding duplicated skill documentation.
+- 80ca852: Add optional `outputSchema` support to `defineTool` and propagate tool output schemas into code mode host tools. Framework tools with fixed result shapes now declare output schemas, provider-managed `web_search` injects the selected provider's output schema at runtime, and code mode logs a warning when an exposed host tool has no output schema.
+
+  Use deterministic per-turn completion hook tokens in the workflow driver so fast subagent resumes cannot collide with a prior turn's completion hook while the Workflow SDK is still persisting disposal.
+
+### Patch Changes
+
+- bdf208a: Connections now recover when the remote server rejects an already-issued
+  token. An MCP `401` (the bearer was revoked or expired out of band) is
+  classified as authorization-required: Ash evicts the stale cached token,
+  tears down the connection, and re-enters the sign-in flow instead of
+  narrating an opaque transport error. A loop guard fails the connection
+  terminally if a freshly authorized token is still rejected, so a broken
+  grant cannot trigger an endless re-authorization loop.
+- f158cb2: Drop verified Slack `http_timeout` retry deliveries so delayed acknowledgements do not start duplicate sessions.
+- 4d59025: Add Apache-2.0 license metadata, a root license file, and publish-time package license copies along with clearer package descriptions and discovery keywords.
+
+## 0.55.3
+
+### Patch Changes
+
+- 4cee7b4: Fix code-mode dropping state written by `action.result` hooks and channel handlers. Nested tool-result events are emitted from a pooled worker's bridge callback, so the synchronous hook and channel `events` dispatch ran under a stale async context and their `defineState` writes were lost. Code mode now re-enters the originating session's context before emitting, matching direct mode.
+
 ## 0.55.2
 
 ### Patch Changes

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/dist/docs/public/meta.json

@@ -15,6 +15,7 @@
     "connections",
     "---",
     "advanced",
+    "guides",
     "---",
     "research"
   ]

package/dist/docs/public/onboarding.md

@@ -28,8 +28,8 @@ Collect these up front. A capable agent should use a structured question UI (suc
 4. **Model provider** — how the agent reaches a model:
    - Vercel project (default) — create a project, or pass `--project <slug>` to link an existing one, and use AI Gateway via OIDC.
    - API key override — pass `--gateway-api-key <key>` to write `AI_GATEWAY_API_KEY` to `.env.local`.
-   - Local only — pass `--local-only` for web/REPL-only setups that should scaffold without a Vercel project; the agent will not reach a model until you add a provider. Slack still requires a Vercel project.
-5. **Deploy** — whether to deploy to Vercel production now. Required for Slack to receive events; pass `--no-deploy` to skip.
+   - Skip Vercel — pass `--skip-vercel` for web/REPL-only setups that should scaffold without a Vercel project or Vercel Services config; the agent will not reach a model until you add a provider. Slack still requires a Vercel project.
+5. **Deploy** — whether to deploy to Vercel production now. Required for Slack to receive events; pass `--skip-deploy` to skip only the final deployment.
 
 ## Step 1 — Scaffold (non-interactive)
 
@@ -42,13 +42,15 @@ npx create-experimental-ash-agent@latest <name> \
   [--team <slug>] \
   [--project <slug>] \
   [--gateway-api-key <key>] \
-  [--local-only] \
-  [--no-deploy] \
+  [--skip-vercel] \
+  [--skip-deploy] \
   --target-dir <parent-dir> \
   --yes --json
 ```
 
-By default the CLI creates a Vercel project named `<name>`, links it non-interactively, and pulls the project's AI Gateway environment. Use `--project <slug>` when the user picked an existing project, `--team <slug>` when they picked a non-current Vercel team, `--gateway-api-key <key>` when they want a pasted key in `.env.local`, and `--local-only` only for web/REPL-only setups where they explicitly do not want Vercel provisioning.
+By default the CLI creates a Vercel project named `<name>`, links it non-interactively, and pulls the project's AI Gateway environment. Use `--project <slug>` when the user picked an existing project, `--team <slug>` when they picked a non-current Vercel team, `--gateway-api-key <key>` when they want a pasted key in `.env.local`, and `--skip-vercel` only for web/REPL-only setups where they explicitly do not want Vercel provisioning or Vercel Services config.
+
+To scaffold into an existing directory instead of creating `<parent-dir>/<name>`, omit `<name>` and pass `--in-place --target-dir <dir>`. Add `-y` / `--yes` only when replacing existing Ash scaffold files is intended; the CLI logs every overwritten file.
 
 The CLI advances as far as it can without human input. When it reaches a login or browser step, it emits an `action-required` record and exits cleanly instead of blocking on a prompt:
 

package/dist/docs/public/tools.mdx

@@ -64,7 +64,11 @@ The AI SDK uses `inputSchema` to validate and transform model input (including Z
 Ash accepts Zod, any Standard Schema, or a plain JSON Schema object. Zod and Standard Schema
 definitions infer the `execute(input, ctx)` input type. Plain JSON Schema is accepted at runtime, but
 TypeScript treats `input` as `Record<string, unknown>` because the schema does not carry a static
-output type.
+input type.
+
+Add `outputSchema` when the tool returns structured data. It is optional, but code mode uses it to
+type host-tool return values inside generated code. Zod and Standard Schema output schemas also type
+the value returned from `execute`.
 
 `agent/tools/lookup_customer.ts`
 
@@ -77,8 +81,12 @@ export default defineTool({
   inputSchema: z.object({
     customerId: z.string(),
   }),
+  outputSchema: z.object({
+    customerId: z.string(),
+    status: z.enum(["active", "inactive"]),
+  }),
   async execute(input) {
-    return { customerId: input.customerId };
+    return { customerId: input.customerId, status: "active" };
   },
 });
 ```

package/dist/skills/agent/SKILL.md

@@ -0,0 +1,169 @@
+---
+name: ash-agent
+description: Public Ash guide for app authors. Use when building Ash apps, writing user-facing docs/examples, explaining project layout, or helping someone deploy and operate an Ash project. Prefer authored-file guidance, minimal examples, and end-user implementation details.
+metadata:
+  author: Ash repo
+  version: "0.0.1"
+---
+
+Use this skill for end-user Ash work.
+
+## When to use this skill
+
+Use this skill when the task is about how an app author uses Ash, including:
+
+- building an Ash app
+- writing or updating public docs and examples
+- explaining agent layout and authoring slots
+- teaching how skills, tools, the sandbox, channels, or subagents fit together
+- showing how to install Ash from npm and get started locally
+- helping someone deploy or operate an Ash app
+
+If the task is mainly about Ash internals, compiler behavior, runtime plumbing, or implementation
+constraints, load the `ash-framework` skill instead.
+
+## How to use this skill
+
+1. Start from the app author's point of view.
+2. Read the bundled references before relying on memory.
+3. Use the scripts in `scripts/` when they match the user's goal.
+4. Keep guidance task-oriented, concrete, and minimal.
+
+## Writing or updating public docs
+
+The docs website at `apps/docs` renders two directories directly:
+
+- `/docs/public` — polished public docs, manually ordered via
+  `/docs/public/meta.json`.
+- `/research/active` — active design notes, mounted under `/docs/research`
+  and listed alphabetically with no meta.json.
+
+Every markdown file in either directory that should render on the site
+**must** have this shape:
+
+```md
+---
+title: "Short page title"
+description: "One-sentence summary of the page."
+url: /custom/site/path # optional, /docs/public only; only if filename ≠ site URL
+---
+
+Body starts here. Do NOT repeat the title as an `# H1` in the body — the
+site renders the frontmatter `title` as the page heading.
+```
+
+After creating a new `/docs/public` page:
+
+- Add its slug to `/docs/public/meta.json#pages` in the section that matches
+  its topic. The slug is the filename without the `.md` extension for root
+  files, or the folder name for subfolder groups. The trailing `"..."` token
+  auto-includes anything missing but gets placed at the bottom — put new
+  pages in the intended position explicitly.
+
+New `/research/active` files need no meta.json work — the Research section
+sorts alphabetically.
+
+Files intentionally excluded from the site (the top-level `README.md` in
+each directory, etc.) should have no frontmatter and be listed in the
+EXCLUDES set of `scripts/check-docs.mjs`. `pnpm docs:check` validates every
+other file in both directories.
+
+## What Ash is
+
+Ash is a filesystem-first framework for durable backend agents.
+Authors define agents on disk with files like `instructions.md`, `skills/`, `tools/`, `sandbox/`,
+`channels/`, `subagents/`, `schedules/`, and `agent.ts`.
+
+## Core behavior to reinforce
+
+- `instructions.md` is the always-on instructions prompt.
+- `skills/` are on-demand procedures loaded only when relevant.
+- `tools/` are typed executable integrations.
+- each agent has exactly one sandbox; the workspace is the filesystem inside it.
+- `sandbox/sandbox.ts` overrides the sandbox definition and `sandbox/workspace/` seeds files; both
+  are optional and the framework supplies a default.
+- `channels/` are authored messaging-platform entrypoints and can seed durable context in
+  `onDeliver()`.
+- `getSession()`, `getSandbox()`, and `getSkill()` are public authored runtime helpers.
+- `getContext()`, `requireContext()`, `hasContext()`, `setContext()`, and `ensureContext()` are the
+  public unified context helpers.
+- channel classes can declare `static readonly contextProviders = [...]` to derive live step-local
+  values from durable context.
+- `SlackChannel` subclasses can override `handleInteraction(ctx, interaction)` for no-wake Slack UI
+  actions, use `getSlackThread()` for thread reads/posts, and call `editMessage(messageTs, renderable)`
+  to update Slack messages inline.
+- `subagents/` are specialist child agents with separate runs.
+- `schedules/` are recurring triggers.
+- `agent.ts` is where model, name, metadata, build, compaction, and workspace preferences live.
+- route auth and IP policy live on the HTTP channel layer, not in `agent.ts`.
+
+## Preferred workflow
+
+Read these bundled references in roughly this order:
+
+1. `references/getting-started.md`
+2. `references/project-layout.md`
+3. `references/skills.md`
+4. `references/runtime-model.md`
+5. `references/deployment.md`
+
+## How to explain Ash well
+
+- lead with how to use Ash, not how Ash is implemented
+- start with the authored filesystem shape and the smallest working path
+- explain when to use each authored slot and show the file path where it lives
+- use one minimal example before edge cases
+- explain that skills are discovered first and loaded through the framework-owned `load_skill` tool
+- explain current boundaries such as root-only `schedules/` when relevant
+- mention the package name is `experimental-ash` while the framework and CLI are called Ash and `ash`
+- note that route auth lives on channels and that `agent.ts` no longer owns it
+- for Slack or custom channel examples, explain the two-step context pattern: `onDeliver()` writes
+  durable keys, then `static readonly contextProviders = [...]` rebuilds live per-step values
+- for Slack UI interactions, explain that `handleInteraction(ctx, interaction)` is the subclass hook
+  for no-wake `block_actions`, `editMessage(messageTs, renderable)` edits messages inline,
+  `getSlackThread()` exposes thread reads/posts, and `SlackRenderable` is the authored output format
+- point people to packaged references instead of assuming repo docs are available
+
+Prefer feature-first framing like:
+
+- "Use a tool when you need typed executable logic."
+- "Use a sandbox when the model needs an isolated shell environment."
+- "Use a skill when you want optional procedure guidance without bloating every turn."
+
+Avoid starting with compiler, discovery, runtime, or harness internals unless the task truly requires them.
+
+## Bundled scripts
+
+Use these packaged scripts when helpful:
+
+- `scripts/bootstrap-from-npm.sh` - scaffold a new Ash app from npm
+- `scripts/add-to-existing-project.sh` - add Ash to an existing app
+- `scripts/verify-local-agent.sh` - reminder of the common local verification commands
+
+## Build, dev, and deployment expectations
+
+- `ash info` validates the authored surface and inspects the resolved app contract.
+- `ash build` compiles artifacts and builds the runtime host output.
+- `ash dev` runs the local host and interactive REPL.
+- stable runtime routes include `GET /.well-known/ash/v1/health`, `POST /.well-known/ash/v1/message`, and `GET /.well-known/ash/v1/runs/:runId/stream`
+- channel webhooks follow `POST /.well-known/ash/v1/channels/<channelId>/webhook` when channels are configured
+- recommend local development first, then Vercel deployment when shared durable hosting matters
+
+## Supporting skills
+
+When public Ash work touches adjacent systems, also load the relevant specialist skills:
+
+- `ash-framework` for compiler, runtime, discovery, or artifact internals
+- `ai-sdk` for AI SDK APIs, tool calling, and provider integration details
+- `workflow` for durable orchestration behavior and step-boundary decisions
+
+For deployment-heavy tasks, it can also help to install Vercel-maintained skills with `npx skills`
+so the agent can pull in current deployment guidance.
+
+## Completion checklist
+
+- keep the answer user-facing and task-oriented
+- if public behavior changes, update public docs too
+- prefer packaged references and scripts over repo-only links
+- run the expected quality gates before considering the work done
+- ensure public API changes are documented and covered by tests

package/dist/skills/agent/references/deployment.md

@@ -0,0 +1,35 @@
+# Deployment Reference
+
+Recommended posture:
+
+1. develop locally
+2. validate with build and checks
+3. deploy to Vercel when you need shared durable hosting
+
+## Common deployment flow
+
+```bash
+vercel login
+vercel link
+pnpm build
+vercel
+```
+
+Production deploy:
+
+```bash
+vercel --prod
+```
+
+## Verify a deployment
+
+- health route responds
+- message route returns a `runId`
+- run stream returns NDJSON lifecycle events
+- any configured channel auth still succeeds in production
+
+## Optional remote REPL
+
+```bash
+ash dev https://<deployment-url>
+```

package/dist/skills/agent/references/getting-started.md

@@ -0,0 +1,58 @@
+# Getting Started Reference
+
+Ash is a filesystem-first framework for durable backend agents.
+
+## Install from npm
+
+The framework is called Ash, the published npm package is `experimental-ash`,
+and the scaffolder package is `create-experimental-ash-agent`.
+
+Guided setup for a human (the wizard asks for each decision):
+
+```bash
+pnpm create experimental-ash-agent -i
+```
+
+When an AI agent sets Ash up on the user's behalf, the create flow is **headless
+by default** — it takes flags (at minimum `<name>` and `--model`) and bails with
+`--help` rather than prompting. Don't improvise it: follow the executable
+**Onboarding** skill, which encodes model, channels (web/Slack), provisioning,
+deploy, and the browser/OAuth handoffs:
+
+- repo: `docs/public/onboarding.md`
+- Markdown: https://ash.labs.vercel.dev/llms.mdx/onboarding
+
+Slack is not a headless create channel. Scaffold/provision headlessly with
+`--channels web`, then add Slack from the project directory with the interactive
+channel setup:
+
+```bash
+ash channels add slack
+```
+
+That setup uses Vercel Connect under the hood:
+
+```bash
+vercel connect create slack --triggers --name <name>
+```
+
+Add Ash to an existing app instead:
+
+```bash
+pnpm add -D experimental-ash
+```
+
+## Smallest working path
+
+1. scaffold or create a project
+2. add `agent/instructions.md`
+3. add `agent/agent.ts`
+4. add one tool if runtime behavior is needed
+5. run `pnpm dev`
+
+## Important naming note
+
+- framework name: Ash
+- npm package name: `experimental-ash`
+- scaffolder package: `create-experimental-ash-agent`
+- CLI name: `ash`

package/dist/skills/agent/references/project-layout.md

@@ -0,0 +1,35 @@
+# Project Layout Reference
+
+Recommended layout:
+
+```text
+my-agent/
+├── package.json
+├── tsconfig.json
+└── agent/
+    ├── agent.ts
+    ├── instructions.md
+    ├── skills/
+    ├── lib/
+    ├── sandbox/
+    ├── tools/
+    ├── channels/
+    ├── schedules/
+    └── subagents/
+```
+
+## Slot guide
+
+- `instructions.md` - base instructions prompt (the legacy `system.md` slot still works with a deprecation warning)
+- `skills/` - on-demand procedures
+- `tools/` - typed executable integrations
+- `channels/` - HTTP or messaging entrypoints; `onDeliver()` writes durable context and static
+  `contextProviders` rebuild live step-local values when needed; Slack channels can override
+  `handleInteraction(...)` for no-wake UI actions
+- `sandbox/` - the agent's single sandbox; optional `sandbox.ts` override and optional
+  `workspace/` seed files
+- `subagents/` - specialist child agents (each carries its own independent `sandbox/`)
+- `schedules/` - recurring jobs
+- `agent.ts` - additive runtime config for model, name, metadata, build, compaction, and workspace
+
+Prefer the nested `agent/` layout for new apps.

package/dist/skills/agent/references/runtime-model.md

@@ -0,0 +1,24 @@
+# Runtime Model Reference
+
+Key runtime ideas for app authors:
+
+- `ash info` resolves and validates the authored surface
+- `ash build` compiles artifacts and host output
+- `ash dev` starts local development and the REPL
+- `POST /.well-known/ash/v1/message` starts or resumes a run
+- `GET /.well-known/ash/v1/runs/:runId/stream` streams lifecycle events
+
+Important mental model:
+
+- message execution is durable
+- follow-up turns can resume the same run
+- tools execute inside framework-owned runtime wrappers
+- subagents run as child runs
+- channels own auth, delivery policy, and per-turn context seeding
+- `onDeliver()` can write durable serializable context before the step runs
+- channel classes can declare `static readonly contextProviders = [...]` to rebuild live
+  non-serializable step-local values after `onDeliver()`
+- Slack channels handle custom `block_actions` inline via `handleInteraction(ctx, interaction)` and
+  use `getSlackThread()` / `editMessage(messageTs, renderable)` for Slack-native reads and updates
+- tools and other authored step code read those values through unified context helpers such as
+  `requireContext(...)`

package/dist/skills/agent/references/skills.md

@@ -0,0 +1,26 @@
+# Skills Reference
+
+Skills are Ash's on-demand procedure layer.
+
+## How skills work
+
+1. Ash discovers skills under `skills/`.
+2. The runtime advertises available skills to the model.
+3. The runtime provides a framework-owned `load_skill` tool.
+4. When the model activates a skill, that skill's instructions join the active turn context.
+
+## Rules that matter
+
+- flat skills can be simple markdown files under `skills/*.md`
+- packaged skills live under `skills/<name>/SKILL.md`
+- packaged `SKILL.md` files must include `name` and `description`
+- tools remain visible whether or not a skill is activated
+- the legacy `allowed-tools` field is not supported
+- skills are loaded through the framework-owned `load_skill` tool
+
+## When to use a skill
+
+Use a skill for optional procedures, call-routing guidance, and repeatable workflows that should not
+inflate every turn.
+
+Do not use a skill for always-on identity or typed execution.

package/dist/skills/agent/scripts/add-to-existing-project.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+pnpm add -D experimental-ash
+
+cat <<'EOF'
+Add your authored agent surface, then use:
+
+  ash info
+  ash build
+  ash dev
+EOF