Canonical AI instruction

Give an AI the brief.
Keep the meaning yours.

This page is a compact, public instruction an AI assistant can follow to produce a validated Orbweaver portable artifact from a system or workflow description.

Authoritative source on GitHub ↗

Share this URL with Codex, Claude, or another capable assistant, then describe the system you want to make durable. The AI proposes semantic data; Orbweaver derives the artifact.

orbweaver.stream/docs/ai-artifact-brief
01

Use this prompt

Copy into an AI session

Create a valid Orbweaver Graph JSON for the workflow or system I describe. Model semantic meaning only: stable IDs, concise labels, nodes, relationships, real system boundaries as groups, descriptions, source references, and annotations for assumptions, risks, constraints, evidence, or decisions. Do not generate coordinates, SVG, CSS, HTML, transforms, or visual styling. Do not invent facts; state assumptions and unresolved questions clearly. Save the result as [name].graph.json, then run: npx orbweaver-html [name].graph.json --output [name].html --theme dark. If validation reports errors, correct the semantic JSON and retry. Report the JSON and HTML paths, graph counts, assumptions, and semantic decisions represented.

02

Required semantic shape

The portable CLI accepts an ordinary Graph JSON document—not a GraphProposal envelope. At minimum it needs a graph ID, nodes with stable IDs and labels, and relationships using node IDs.

{
  "id": "order-recovery",
  "title": "Order recovery workflow",
  "nodes": [
    { "id": "payment-failed", "label": "Payment failed", "type": "event", "group": "recovery" },
    { "id": "review", "label": "Review recovery", "type": "process", "group": "recovery" }
  ],
  "edges": [
    { "id": "failure-review", "from": "payment-failed", "to": "review", "type": "event" }
  ],
  "groups": [{ "id": "recovery", "label": "Recovery workflow" }]
}
Meaning, not geometry

Use a node's group field for its system boundary. Never ask the AI for coordinates, SVG paths, CSS, HTML, or manually arranged layout.

03

Generate and review

[name].graph.jsonsemantic source; stable IDs and reviewable assumptionsnpx orbweaver-htmlvalidates, derives layout, and creates the artifact[name].htmlself-contained SVG, inspection, selection, and provenance
  • Keep the JSON beside the generated HTML so the artifact is reproducible.
  • Open the HTML and inspect nodes, relationships, groups, and annotations.
  • Correct semantic JSON and regenerate when the meaning changes.
  • Treat AI claims as review inputs—not proof of factual truth.
04

What the artifact does and does not contain

Contains

Durable understanding

Accessible SVG, semantic inspection, relationship emphasis, annotations, provenance, and optional theme controls—all self-contained.

Does not contain

Execution authority

No WebMCP tools, model credentials, host callbacks, editor, secrets, or workflow runner. Keep sensitive material out of the graph.

Read the complete Portable HTML guide →