Skip to content

Commit 55c0a76

Browse files
committed
update README
1 parent 5b3534c commit 55c0a76

1 file changed

Lines changed: 11 additions & 6 deletions

File tree

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,13 @@ The full product vision, YAML spec v0, and architecture are documented in [**`do
4141
## Features (MVP today)
4242

4343
- **`agentctl init`** — scaffold `project.yaml`, policies, tools, and a sample workflow
44-
- **`agentctl validate`** — load project, apply defaults/env overlays, validate graph, schemas, and references
45-
- **`agentctl plan`** — diff desired graph vs SQLite **deployment** state; risk hints
46-
- **`agentctl apply`** — persist plan (with TTY confirm or `--auto-approve` / `AGENTCTL_AUTO_APPROVE`)
44+
- **`agentctl validate`** — load project, apply **project defaults** (`spec.defaults`), then **environment overlays** (`-e` / `--env`, `Environment` resources §7.6), then validate graph, schemas, and references
45+
- **`agentctl plan`** — diff desired graph vs SQLite **deployment** state; risk hints; JSON/YAML output includes a **`deploymentBaseline`** digest for the store snapshot
46+
- **`agentctl apply`** — persist plan (TTY confirm or `--auto-approve` / `AGENTCTL_AUTO_APPROVE`); **optimistic concurrency** — if the deployment store changed after the plan snapshot (e.g. another process applied the same `--state` file while this run waited at the prompt), apply fails with **exit code 3**; re-run **plan** then **apply**
4747
- **`agentctl run`** — execute a workflow locally; JSON Schema for inputs where configured; policy gates
4848
- **`agentctl logs`** — read **trace events** from SQLite (`--run`, `--workflow`, or recent runs)
49+
- **Tools****`native`**, **`http`**, **`mock`**, and **`mcp`** — MCP supports **stdio** (subprocess) or **streamable HTTP** (`spec.mcp.transport: http`, `url`, optional `headers` with `env:` tokens)
50+
- **Project defaults** — besides **`model`** and **`policy`**, optional **`runtime`** flows to **`spec.runtime`** on agents/workflows when omitted (MVP: **`local`** or unset; see spec validation)
4951
- **Output** — table, JSON, or YAML (`-o` / `--output`)
5052
- **State** — single SQLite file (default `.agentic/state.db` under the project root; override with `--state`)
5153
- **Tests** — unit/integration coverage, golden CLI output tests, end-to-end `init → … → logs` in `test/integration`
@@ -117,6 +119,7 @@ spec:
117119
defaults:
118120
policy: default
119121
model: openai/gpt-4o-mini
122+
runtime: local
120123
providers:
121124
models:
122125
openai:
@@ -128,7 +131,7 @@ spec:
128131
# apiKeyFrom: env:ANTHROPIC_API_KEY
129132
```
130133

131-
Field-by-field rules, extra kinds, and env overlays are in [`docs/DESIGN_DOC.md`](docs/DESIGN_DOC.md). See [`docs/EXAMPLES.md`](docs/EXAMPLES.md) for an Anthropic **`project.yaml`** fragment and structured-output notes.
134+
Field-by-field rules, extra kinds, env overlays, MCP HTTP tools, and **`defaults.runtime`** are in [`docs/DESIGN_DOC.md`](docs/DESIGN_DOC.md). See [`docs/EXAMPLES.md`](docs/EXAMPLES.md) for Anthropic fragments, MCP over HTTP, and structured-output notes.
132135

133136
Notes:
134137

@@ -205,8 +208,10 @@ GO_UPDATE_GOLDEN=1 go test ./internal/cli/... -run TestGolden_
205208

206209
### Near term (MVP hardening)
207210

208-
- More **`diff` / drift** UX where the design doc calls for it
209-
- **`inspect`** and richer **`logs`** filters (see sections **10.2** and **17.3** in `docs/DESIGN_DOC.md`)
211+
Recent landings already cover much of “hardening”: **plan/apply optimistic concurrency** (exit **3** when deployment state drifts), **MCP** over **streamable HTTP** as well as stdio, **trace retention** (`spec.traces.retentionDays`), **`defaults.runtime`** / **`spec.runtime`** (MVP `local`), and clearer **defaults vs environment overlay** documentation. What is still open for near-term polish:
212+
213+
- More **`diff` / drift** UX where the design doc calls for it (beyond today’s resource-level diff)
214+
- Richer **`inspect`** output and **`logs`** filtering (see sections **10.2** and **17.3** in `docs/DESIGN_DOC.md`)
210215
- **`agentctl test`**-style workflow fixtures (**stretch** per design doc)
211216

212217
### Post-MVP (from design doc section 19)

0 commit comments

Comments
 (0)