Skip to content

Workflow authoring tools

Orch8 workflows have one portable JSON contract. You can write that contract directly, build it with an SDK, generate a draft with an LLM, or let an MCP client author it. Every path converges on the same schema, lint, preflight, and offline contract tests.

Warning
The tools on this page are merged to the engine's currentmain branch and are not part of the 0.7.1 release. Pin a commit for evaluation until the next version is tagged.

Editor and API contracts

Configure your editor with the recursive sequence JSON Schema. The versioned OpenAPI document is the source for HTTP clients and exact request and response types.

https://orch8.io/contracts/sequence.schema.json
https://orch8.io/contracts/openapi.json

New definitions include schema_version and can be upgraded explicitly with orch8 sequence upgrade-format. Stored older definitions continue to decode through compatibility defaults.

Local Studio

The current-main local path is persistent by default: initialize a project, then edit while the Studio hot-reloads and keeps state in.orch8/dev.db.

Bash
orch8 init my-project
orch8 dev my-project

# Fast, in-memory CI smoke test
orch8 dev my-project --no-server --skip-timers --once

Generate and repair with an LLM

orch8 generate uses an OpenAI-compatible provider, validates the draft, and runs a bounded repair loop. Review the resulting JSON and contract tests before applying it.

Bash
orch8 generate "triage support tickets with human escalation"
orch8 sequence preflight --file sequence.json
orch8 test run sequence.contracts.json

Claude and Cursor through MCP

Point an MCP client at POST /api/v1/mcp. In addition to run operations, current main exposes sequence creation, lint, and preflight tools so an assistant can repair a workflow against engine evidence instead of guessing the DSL.

JSON
{
  "mcpServers": {
    "orch8": {
      "url": "http://localhost:8080/api/v1/mcp",
      "headers": {
        "x-api-key": "<ORCH8_API_KEY>",
        "x-tenant-id": "demo"
      }
    }
  }
}

Code-first builders

The TypeScript, Python, and Go SDKs expose builders for all eleven block types. Builders produce ordinary sequence JSON, so definitions remain portable and can be reviewed or deployed without the originating SDK. Start with the SDK guide.

GitHub Actions and release gates

The reusable action runs format validation, lint, preflight, semantic diff, offline contract tests, and optional canary evidence. It is the shortest path from a reviewed sequence file to a guarded deployment.

- uses: orch8-io/engine@main
  with:
    sequence: sequences/checkout.json
    contracts: sequences/checkout.contracts.json

Ready to try Orch8?

One command to install. Then run your first local sequence.

Bash
curl -fsSL https://orch8.io/start.sh | sh
Was this helpful?