Skip to content

Latest commit

 

History

History
334 lines (283 loc) · 13.2 KB

File metadata and controls

334 lines (283 loc) · 13.2 KB

Skill To Graph

Start with Getting Started. This page takes the same examples/hello-world skill and composes it into a two-step graph.

Graph Shape

The example graph lives at examples/hello-graph/graph.yaml:

name: hello-graph
owner: runx
steps:
  - id: first
    skill: ../hello-world
    inputs:
      message: hello from graph
  - id: second
    skill: ../hello-world
    context:
      message: first.stdout

The first step runs the skill with an explicit input. The second step reads the first step's stdout and passes it as the next message input. The graph receipt links both step receipts, so inspection can show what ran and how the steps connected.

Graph steps may also execute a cataloged skill from the local registry:

steps:
  - id: build_docs
    skill: registry:runx/sourcey@1.0.0
    runner: sourcey
    inputs:
      objective: refresh the public docs

Executable registry refs are explicit (registry:..., runx-registry:..., or runx://skill/...) and resolve only from RUNX_REGISTRY_DIR. Graph execution does not fetch remote registry content implicitly; the operator must install, publish, or sync the skill into the local registry first. At runtime runx materializes the resolved SKILL.md and optional X.yaml into .runx/registry-step-skills/ as a generated cache, then executes the normal skill runner path against that materialized package.

Skill Context For Agents

Agent steps can also ask for whole skills as context without executing those skills. Use context_skills when a downstream agent should read a reusable capability, guideline, rubric, or operating procedure as part of its prompt context:

steps:
  - id: apply_taste
    run:
      type: agent-task
      agent: builder
      task: apply taste guidance
      outputs:
        summary: string
    context_skills:
      - taste-profile
      - registry:runx/taste-profile@1.0.0

Each entry becomes a runx.skill.context artifact in the agent invocation's generic current_context array. The artifact carries the source ref, skill name, digest, and SKILL.md content. It does not create a domain schema for the skill; the skill remains an abstract context/capability document.

Local path refs resolve relative to the graph skill directory and must stay inside the owning skill root. Use registry refs for cataloged skills shared across skill roots. Registry refs use the local registry (RUNX_REGISTRY_DIR) and must be explicit (registry:..., runx-registry:..., or runx://skill/...). Graph execution does not fetch remote registry content implicitly; install or ingest the skill first, then reference the local registry.

The gates are intentionally narrow:

  • context_skills is accepted only on direct agent-task steps or nested skills and stages that resolve to agent/agent-task.
  • Local refs must be relative paths, must not contain .., must not target private graph stages under skills/<name>/graph/<stage>/, and must contain a valid SKILL.md.
  • A context skill with an X.yaml catalog entry cannot use an implementation-only role (graph-stage, runtime-path, or harness-fixture). Internal catalog entries are context-loadable only when they explicitly declare catalog.role: context.
  • Registry refs resolve only from the configured local registry.
  • Each context skill is capped at 64 KiB, the step is capped at 12 context skills, and total resolved skill context is capped at 256 KiB.
  • Duplicate context refs are rejected.
  • Every context artifact is digest-bound and labeled security_boundary: untrusted-agent-context.
  • Explicitly enabled native managed-agent execution passes the artifacts to the provider with an explicit instruction that context artifacts are advisory data, not system instructions or authority to change tools, reveal secrets, or bypass policy.

Run The Harness

Use the graph harness as the executable contract:

cargo build --manifest-path crates/Cargo.toml -p runx-cli
crates/target/debug/runx harness examples/hello-graph/harness.yaml --json

The harness expects a sealed runx.receipt.v1 receipt and the ordered steps first, then second.

When To Use A Graph

A single agent-task runner is one bounded agent act. It carries its own instructions and allowed_tools and normally yields needs_agent to the calling agent. --managed-agent explicitly delegates that act to the configured in-process provider for the current run; credentials alone never enable it. The round cap is shown in prepared context and defaults to four. Not everything needs a graph. Reach for one when a single judgment step produces the result.

Reach for a graph when the work has explicit phases, when a later step consumes an earlier step's receipt-backed output, or when approval and revision boundaries need to be visible in the execution record.

The line between them is not how many model calls there are; it is what must be guaranteed. The model is for judgment and authoring, never for guaranteeing a side effect: an agent handed a mutating tool may narrate the action ("done, claimed it") instead of calling it. So an action that must happen, a mutation, an API call, a payment, belongs in a deterministic step (tool:, http:, or skill:), not in an agent's allowed_tools where the call is optional. The governed shape is a graph where an agent step authors or decides and the next deterministic step performs the act; one receipt seals both. Agent steps yield needs_agent unless the current invocation explicitly supplies --managed-agent; provider configuration alone does not change execution.

Graphs should stay small enough to review. If the graph is carrying hidden policy decisions, split the policy into the skill profile or a separate governed step instead of burying it in prose.

For long-running agent workflows, do not turn a graph into an unbounded resident loop. Use Loop Orchestration: an outer loop host submits one governed runx turn at a time, reads receipts and projections, and continues only when explicit stop policy allows.

Domain Receipts: The act: Declaration

By default a receipt records that a step ran. A runner can instead declare an act: block so the sealed receipt reads as the domain act it performed: what was decided, on what, under what authority, with what effect, and what it follows.

The discipline is a trust boundary. The model authors only the human reason; the structure and authority come from the declaration plus trusted inputs, never from the model, so it cannot forge what kind of act happened, what it targeted, or under what right. A run that declares no act: block seals exactly as before.

Each field maps to a trusted source, a literal or driver-pinned from an input (<field>_from: <input>):

runners:
  approve:
    type: agent-task            # or a graph; see below
    act:
      form_from: act_form        # review | revision | reply | observation | verification
      purpose_from: act_purpose  # what this act is
      target_from: target_ref    # the entity acted on (a ref uri)
      decision_from: decision    # accept | reject | continue | ... -> the receipt decision
      authority_from: authority  # the right exercised (a grant ref)
      actor_from: actor          # who acted (a principal ref)
      reason_from: note          # the agent's authored line -> the act summary
      previous_from: prior       # the receipt this one chains from (lineage)

For a graph, the reason and effect come from steps, not the agent's final answer, so the effect is read from the deterministic action step's real result, never the model's restatement of it:

    act:
      reason_step: decide        # the agent step whose output holds the reason
      reason_from: line          # the field in that step's output
      effect_step: act           # the deterministic action step
      effect_from: id            # the field of its result that is the consequence id
      effect_prefix_from: ns     # wraps it, e.g. ticket: -> ticket:<id>
      # form/purpose/target/decision/authority/actor as above

Transport never enters the receipt: the tool name, url, status, and any token stay out; only the domain act and its effect ref are sealed. See the act model for the receipt's act/decision shape.

HTTP Steps And Credentials

Every executing Runx CLI command captures one workspace environment when the command starts. Help and version rendering remain independent of workspace state. Runx first resolves the workspace from the process environment and current directory, then parses the exact <workspace>/.env file when it exists. The file only fills missing keys, so an exported process value always wins. Runx parses the file as data; it does not source a shell or mutate the process environment.

Keep .env local and ignored by version control. Loading a key makes it available to declared credential resolution, but does not make it ambient child configuration. Credential delivery is a separate runtime channel. Executable runners declare non-secret configuration once through environment.required and environment.optional; the same declaration drives CLI, MCP, and deterministic JavaScript delivery.

A graph performs governed HTTP through the native http.read, http.query, or http.execute capability. There is no parallel HTTP source or tool-manifest adapter. Each step supplies bounded request records, an exact public-host allowlist, and net:http scope. Path values are typed inputs and are percent-encoded before transport:

steps:
  - id: read_account
    tool: http.read
    scopes: [net:http]
    inputs:
      requests:
        - id: account
          method: GET
          url: https://api.example.com/v1/accounts/{account_id}
          path:
            account_id: $input.account_id
      allowed_hosts: [api.example.com]
      stop_on_error: true

For authenticated calls, bind the runner credential and declare the native tool's auth input. Runx injects delivered material at the transport boundary; skills must not construct authorization headers themselves:

Declare the provider contract on the runner:

credentials:
  example-crm:
    provider: example-crm
    auth:
      api_key:
        delivery:
          env: EXAMPLE_CRM_TOKEN
runners:
  main:
    type: graph
    credential: example-crm
    graph:
      steps:
        - id: read_account
          tool: http.read
          scopes: [net:http]
          inputs:
            requests:
              - id: account
                method: GET
                url: https://api.example.com/v1/accounts
            allowed_hosts: [api.example.com]
            auth:
              type: bearer
              secret_env: EXAMPLE_CRM_TOKEN

For durable local use, pipe material into runx credential set and select it with --profile; an ignored .env remains the low-friction fallback. See Credential Resolution for the manifest contract, resolution order, project bindings, multi-auth providers, resume behavior, and MCP startup readiness. skills/nws-weather-forecast is the canonical public native-HTTP proof; credentialed provider skills use the same transport and auth boundary.

Governed Data Steps

Use the data plane when a graph needs durable state, not when it needs a model to invent database commands. The canonical shape is a domain skill followed by a declared data operation:

steps:
  - id: decide
    skill: ./your-domain-skill
    runner: claim
  - id: append
    skill: ./data-store
    runner: append_event
    inputs:
      data_source_ref: "$input.data_source_ref"
      resource: board_events
      aggregate_id: "$input.posting_id"
      expected_version: "$input.expected_version"
      idempotency_key: "$input.idempotency_key"
    context:
      event: decide.claim_packet.data

The storage provider can be SQL, Redis, D1, DynamoDB, object storage, or a product API. Provider details live behind an adapter. The graph sees a declared operation and receives runx.data.operation_result.v1 with version movement, digests, redaction notes, and provider evidence.

Storage choice is not product logic. A graph passes data_source_ref such as local://runx-data-store/dev-board or tenant://acme/board; project or hosted configuration binds that source to native SQLite or a conforming external provider such as data.redis. The data-store runners call exact native operations, and unbound local://... refs use a source-scoped SQLite database at .runx/data/local-sources/source-<digest>.sqlite. Production capability packs keep the same operation inputs and move provider choice into the data-source binding rather than forking the domain skill.

Do not put board, CRM, billing, or support-specific state machines into the data adapter. Domain skills own meaning; data adapters own bounded reads, idempotent writes, and projection evidence. See the governed data plane.

Use inputs for literals, $input.* values, and static configuration. Use context when a step needs an earlier step's output:

steps:
  - id: select
    run:
      type: agent-task
  - id: review
    run:
      type: agent-task
    context:
      bounty: select.result

inputs: { bounty: select.result } is rejected because it looks like a step output reference placed in the wrong field.