Skip to content

docs: use the canonical launcher quickstart #28

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
abrichr merged 2 commits into from
Aug 18, 2026
Merged

docs: use the canonical launcher quickstart #28

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
371dc98
docs: use canonical launcher quickstart
abrichr Aug 18, 2026
5a0db51
docs: keep quickstart bundle read-only
abrichr Aug 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,18 +43,16 @@ Python 3.10–3.12 is supported. The package installs a compatible

## Serve compiled workflows

Compile a workflow with Flow, then serve its bundle directory:
Create a governed local tutorial bundle through the canonical launcher, then
serve that bundle directory:

```bash
openadapt-flow demo-record --out /tmp/recording
openadapt-flow compile /tmp/recording \
--out /tmp/bundles/triage \
--name "Demo Triage"
python -m pip install --upgrade 'openadapt[browser]'
openadapt quickstart --out /tmp/openadapt-agent-demo

openadapt-agent serve \
--bundles /tmp/bundles \
--runs-dir /tmp/openadapt-runs \
--allow-run
--bundles /tmp/openadapt-agent-demo/bundle \
--runs-dir /tmp/openadapt-runs
```

For example, register it with an MCP client that accepts a local stdio
Expand All @@ -63,17 +61,19 @@ command:
```bash
claude mcp add openadapt-workflows -- \
openadapt-agent serve \
--bundles /tmp/bundles \
--runs-dir /tmp/openadapt-runs \
--allow-run
--bundles /tmp/openadapt-agent-demo/bundle \
--runs-dir /tmp/openadapt-runs
```

The client receives `list_workflows`, `get_workflow`,
`get_run_report`, `list_needs_attention`, `get_attention_item`, and one
typed `run_workflow_<opaque-id>` tool per loadable bundle. Declared
parameters are required; recorded demonstration values never appear in
the schema and are not silently reused. Omit `--allow-run` when the
client should be able to inspect workflows but not start them.
The client receives the read-only `list_workflows`, `get_workflow`,
`get_run_report`, `list_needs_attention`, and `get_attention_item` tools. The
quickstart stops its synthetic application after the verified tutorial run, so
this retained bundle is an inspection example, not a second runnable tutorial.

The deployment-configured example below adds `--allow-run`. It registers one
typed `run_workflow_<opaque-id>` tool per loadable bundle. Declared parameters
are required; recorded demonstration values never appear in the schema and are
not silently reused.

By default every MCP response is safe to render outside the protected
workflow-data boundary. Workflow labels and intents, recorded values,
Expand Down Expand Up @@ -201,7 +201,7 @@ success.

```bash
openadapt-agent emit-skill \
/tmp/bundles/triage \
/tmp/openadapt-agent-demo/bundle \
--out ~/.claude/skills
```

Expand Down