Skip to content

Commit ce54354

Browse files
deploy: bd50dfa
1 parent 35226a1 commit ce54354

186 files changed

Lines changed: 972 additions & 742 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

2.0/llms-full.txt

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ The sample app also exposes `/mcp/workflows` for AI clients. Start with
4848
`get_workflow_history` to operate on v2 workflow instances through structured
4949
JSON instead of scraping UI text.
5050

51+
For agent-facing docs, MCP, CLI, and diagnostic handles, see
52+
[AI-assisted development](/docs/2.0/ai-assisted-development).
53+
5154
Not using Laravel? See the [standalone server](/docs/2.0/polyglot/server), [CLI](/docs/2.0/polyglot/cli), or [Python SDK](/docs/2.0/polyglot/python).
5255

5356
# Installation
@@ -5433,6 +5436,10 @@ That's it! You can now create and test workflows.
54335436

54345437
The sample app also exposes a Laravel MCP server at `/mcp/workflows`. This is the reference AI-client surface for Durable Workflow v2: it gives agents structured workflow discovery, start, status, output, recent typed history, and failure facts without requiring them to scrape Waterline.
54355438

5439+
For the broader AI-assisted development contract, including v2 LLM manifests,
5440+
CLI exit codes, Waterline exports, and SDK references, see
5441+
[AI-assisted development](/docs/2.0/ai-assisted-development).
5442+
54365443
The MCP server is registered from `routes/ai.php` by the Laravel MCP package. The exposed workflow keys live in `config/workflow_mcp.php`; each entry can include the workflow class plus discovery metadata such as a description, credential requirements, and expected arguments.
54375444

54385445
Default tools:
@@ -5455,6 +5462,90 @@ A typical agent loop is:
54555462

54565463
Use `simple` or `elapsed` for no-credential smoke tests. The `prism` workflow is intentionally exposed as an AI example, but it requires `OPENAI_API_KEY` before a worker can complete it.
54575464

5465+
# AI-Assisted Development
5466+
5467+
Durable Workflow v2 is designed so a person can learn the durable execution
5468+
model, then let tools handle the repeated inspection and operation work. The
5469+
important product surface is not a chat prompt; it is the set of stable handles
5470+
an agent can read, call, and cite without guessing.
5471+
5472+
## Retrieval Surfaces
5473+
5474+
Use the versioned v2 LLM artifacts when asking an AI assistant about the
5475+
unreleased v2 protocol:
5476+
5477+
| Surface | URL | Use |
5478+
| --- | --- | --- |
5479+
| v2 manifest | `https://durable-workflow.com/llms-2.0.txt` | Lightweight index of v2 docs source files. |
5480+
| v2 full bundle | `https://durable-workflow.com/llms-full-2.0.txt` | Single-file v2 docs bundle for retrieval. |
5481+
| canonical manifest | `https://durable-workflow.com/llms.txt` | Current stable docs. This remains 1.x until v2 is released. |
5482+
| canonical full bundle | `https://durable-workflow.com/llms-full.txt` | Current stable full bundle. This remains 1.x until v2 is released. |
5483+
5484+
Keep the version explicit in agent instructions. During the v2 prerelease
5485+
period, ask for the `2.0` docs or provide the v2 manifest URL directly.
5486+
5487+
## Local MCP Surface
5488+
5489+
The [sample app](/docs/2.0/sample-app) exposes a Laravel MCP server at
5490+
`/mcp/workflows`. It is the reference AI-client integration for local v2
5491+
workflow development.
5492+
5493+
The MCP server gives an agent structured workflow operations instead of UI
5494+
scraping:
5495+
5496+
| Tool | Stable handle |
5497+
| --- | --- |
5498+
| `list_workflows` | Discover configured workflow keys, credential requirements, status values, and recent runs. |
5499+
| `start_workflow` | Start a configured v2 workflow and receive `workflow_id`, `run_id`, status, business key, and command outcome. |
5500+
| `get_workflow_result` | Poll the current or selected run for status, output, visibility metadata, and latest failure summary. |
5501+
| `get_workflow_history` | Fetch a bounded tail of typed v2 history events and recent durable failures. |
5502+
5503+
Use `simple` or `elapsed` as no-credential smoke tests. Use workflows with
5504+
external credentials only after the local environment contains the required
5505+
keys.
5506+
5507+
## Command And Diagnostic Contracts
5508+
5509+
Agents should prefer machine-readable surfaces over screenshots or prose:
5510+
5511+
- `dw` commands expose stable exit codes for automation. See the
5512+
[CLI reference](/docs/2.0/polyglot/cli#exit-codes).
5513+
- Server health, info, namespace, workflow, schedule, worker, and task-queue
5514+
commands are the right handles for shell-based checks.
5515+
- Waterline history export is the source for replay and failure diagnosis. It
5516+
includes typed history events, projection source metadata, integrity checks,
5517+
selected-run context, waits, timers, lineage, and latest durable failures.
5518+
- Python SDK types and method signatures live in the generated
5519+
[Python API reference](https://python.durable-workflow.com/).
5520+
5521+
When an agent needs to explain a stuck workflow, collect these facts first:
5522+
5523+
1. `workflow_id` and `run_id`
5524+
2. current run status and latest failure summary
5525+
3. recent typed history events
5526+
4. open waits, timers, and pending tasks
5527+
5. worker and task-queue health
5528+
6. the relevant docs version, usually `2.0` during prerelease work
5529+
5530+
That set is enough to distinguish a durable workflow failure from a worker
5531+
runtime failure, a missing external credential, a queue outage, or an operator
5532+
action waiting for approval.
5533+
5534+
## Prompt Shape
5535+
5536+
Give coding agents explicit constraints and handles:
5537+
5538+
```text
5539+
Use Durable Workflow v2 docs from https://durable-workflow.com/llms-full-2.0.txt.
5540+
Use the sample app MCP endpoint at /mcp/workflows for workflow discovery,
5541+
start, result, and history. Prefer dw JSON/exit-code contracts and Waterline
5542+
history exports over screenshots. Do not use 1.x Workflow\Workflow examples
5543+
unless I ask for the stable 1.x API.
5544+
```
5545+
5546+
The goal is simple: humans learn the workflow/activity/replay invariant, and
5547+
tools operate through documented contracts instead of inferred product behavior.
5548+
54585549
# Testing
54595550

54605551
## `Workflow\V2`

404.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@
1313

1414

1515
<link rel="search" type="application/opensearchdescription+xml" title="Durable Workflow" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.bdb910b5.css">
16-
<link rel="preload" href="/assets/js/runtime~main.482ed9f8.js" as="script">
17-
<link rel="preload" href="/assets/js/main.2242c90e.js" as="script">
16+
<link rel="preload" href="/assets/js/runtime~main.e1fb0826.js" as="script">
17+
<link rel="preload" href="/assets/js/main.46d12ec1.js" as="script">
1818
</head>
1919
<body class="navigation-with-keyboard">
2020
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
2121
<div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Workflow Logo" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo.svg" alt="Workflow Logo" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Durable Workflow</b></a><a class="navbar__item navbar__link" href="/docs/installation/">Docs</a><div class="navbar__item dropdown dropdown--hoverable"><a class="navbar__link" aria-haspopup="true" aria-expanded="false" role="button" href="/docs/introduction/">1.x</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/2.0/introduction/">2.0</a></li><li><a class="dropdown__link" href="/docs/introduction/">1.x</a></li></ul></div><a class="navbar__item navbar__link" href="/blog/">Blog</a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" aria-label="Star Durable Workflow on GitHub" class="navbar-github-star-link navbar__item navbar__link" label="Star on GitHub"><svg aria-hidden="true" class="navbar-github-star-link__icon" viewBox="0 0 16 16"><path d="M8 0C3.58 0 0 3.58 0 8a8.01 8.01 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.5-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.56 7.56 0 0 1 8 4.76c.68 0 1.36.09 2 .27 1.53-1.03 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.28.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg><span class="navbar-github-star-link__count" title="GitHub stars">1.2K</span></a><a href="https://github.com/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" aria-label="Star Durable Workflow on GitHub" class="navbar-github-star-link navbar__link navbar-github-star-link--mobile-topbar" label="Star on GitHub"><svg aria-hidden="true" class="navbar-github-star-link__icon" viewBox="0 0 16 16"><path d="M8 0C3.58 0 0 3.58 0 8a8.01 8.01 0 0 0 5.47 7.59c.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.5-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82A7.56 7.56 0 0 1 8 4.76c.68 0 1.36.09 2 .27 1.53-1.03 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.28.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.01 8.01 0 0 0 16 8c0-4.42-3.58-8-8-8Z"></path></svg><span class="navbar-github-star-link__count" title="GitHub stars">1.2K</span></a><div class="toggle_vylO colorModeToggle_x44X"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently dark mode)" aria-label="Switch between dark and light mode (currently dark mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><main class="container margin-vert--xl"><div class="row"><div class="col col--6 col--offset-3"><h1 class="hero__title">Page Not Found</h1><p>We could not find what you were looking for.</p><p>Please contact the owner of the site that linked you to the original URL and let them know their link is broken.</p></div></div></main></div><div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/introduction/">Introduction</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/installation/">Installation</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://discord.gg/xu5aDDpqVy" target="_blank" rel="noopener noreferrer" class="footer__link-item">Discord<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://x.com/DurableWorkflow" target="_blank" rel="noopener noreferrer" class="footer__link-item">X<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://durable-workflow.com/llms-full.txt" target="_blank" rel="noopener noreferrer" class="footer__link-item">LLM Docs<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://packagist.org/packages/durable-workflow/workflow" target="_blank" rel="noopener noreferrer" class="footer__link-item">Packagist<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 <a href="https://durable-workflow.com">Durable Workflow</a>.</div></div></div></footer></div></div>
22-
<script src="/assets/js/runtime~main.482ed9f8.js"></script>
23-
<script src="/assets/js/main.2242c90e.js"></script>
22+
<script src="/assets/js/runtime~main.e1fb0826.js"></script>
23+
<script src="/assets/js/main.46d12ec1.js"></script>
2424
</body>
2525
</html>

0 commit comments

Comments
 (0)