Status: Stable · maintained compatibility major. New implementations
should target v2; this tree remains normative for v1 clients and dual-stack
hosts during the migration window.
OpenWOP v1 is the maintained compatibility major. Target v2 for new work; implement v1 when supporting an existing v1 client or a dual-stack host during the migration window.
This directory contains explanatory and normative prose. When prose and a machine-readable contract disagree, use the following precedence:
1. api/openapi.yaml and api/asyncapi.yaml for HTTP and event surfaces. 2. schemas/ for payload validation. 3. The normative requirements in these documents. 4. RFC history and examples, which provide rationale but do not override the published wire contract.
Normative keywords (MUST, MUST NOT, SHOULD, and MAY) follow RFC 2119. Open issues are tracked centrally in gaps.json; migration and removal status are tracked in migrations.json and deprecations.json.
Start here
| Goal | Read |
|---|---|
| Discover a host and negotiate compatibility | capabilities.md, version-negotiation.md, profiles.md |
| Create and observe a run | rest-endpoints.md, run-options.md, stream-modes.md |
| Suspend for human input | interrupt.md, interrupt-profiles.md |
| Implement durable execution | storage-adapters.md, idempotency.md, replay.md |
| Implement agents | multi-agent-execution.md, ai-envelope.md, agent-memory.md |
| Publish reusable components | node-packs.md, workflow-chain-packs.md, registry-operations.md |
| Secure a host | auth.md, auth-profiles.md, host-extensions.md |
Document map
Wire and execution
rest-endpoints.md— REST operation catalog.capabilities.mdand
capabilities-change-detection.md — discovery, feature advertisement, and cache validation.
version-negotiation.md— protocol, engine, and
event-schema versioning.
channels-and-reducers.md— typed shared state.run-options.md— per-run configuration overlay.stream-modes.md— SSE projections and resumption.interrupt.mdand
interrupt-profiles.md — suspend/resume and approval profiles.
idempotency.md,replay.md, and
compensation.md — retry safety, forks, and failure recovery.
storage-adapters.md— event-log and suspension
persistence contracts.
Agents, prompts, and tools
ai-envelope.mdand
structured-output-subset.md — typed model output and the informative provider-compatibility subset.
multi-agent-execution.md— execution and
handoff model.
agent-workspace.md, and agent-runtime.md — memory, files, and standing goals.
agent-evaluation.md, agent-roster.md, and agent-org-chart.md — lifecycle and inventory.
agent-platform-profile.md — identity mapping and the aggregate platform profile.
prompts.mdandtool-catalog.md— prompt
distribution and portable tool discovery.
Packs and registries
workflow-chain-packs.md, and registry-operations.md — executable packs, reusable workflow fragments, and registry lifecycle.
artifact-type-packs.md, chat-card-packs.md, and form-content-packs.md — specialized pack types.
frontend-plugin-packs.md— sandboxed UI
extensions.
Host services and integrations
host-extensions.md — pack-facing host services and extension namespaces.
a2a-integration.md — MCP and A2A composition.
grpc-transport.md, and cloudevents-mapping.md — delivery and transport profiles.
self-hosted-runner.md— outbound-connected local
execution.
Operations, security, and supporting profiles
auth.md,auth-profiles.md, and
compliance.md — identity, authorization, and an informative compliance mapping.
observability.mdand
debug-bundle.md — telemetry and diagnostics.
scale-profiles.md, core-standard-profile.md, and conformance-certification.md — operational and evidence profiles.
budget-policy.md— quota and cost controls.i18n.mdand
localized-content.md — language negotiation and authored localized content.
portability.md— export/import extension.host-sample-test-seams.md— optional
conformance observation seams; not application endpoints.
positioning.md— non-normative comparison with adjacent
standards.