Workflow capability actions reference

Workflow capability actions reference

Load a capability file below when authoring capability:<type>.<operation> tasks.
Param tables are generated from each capability's OpDef.Input (same source as hub registration).

Rules for agents:

  1. Only use capability types listed in the table below.
  2. Before emitting any capability:<type>.* action, load capabilities/<type>.md and copy required params from that file.
  3. Do not invent ops, param keys, or types (for example there is no capability:archive.*).

Result envelope

Every capability step stores a JSON InvokeResult string as {{step "id" "result"}}:

Field Meaning
capability Capability type (e.g. karakeep, core)
operation Operation name
data Domain payload (object, array, or scalar); omit when empty
text Optional short human summary
page Optional pagination for list ops

Usage patterns:

  • Field: {{jsonpath (step "save" "result") "data.url"}}
  • Exists: {{if jsonpathExists (step "save" "result") "data.id"}}...{{end}}
  • Whole JSON (rare): {{step "save" "result"}}

Mutation ops change remote/system state; prefer read ops when exploring.

Common data paths

Op pattern Typical jsonpath
karakeep.create / get data.id, data.url, data.title
karakeep.check_url data.exists, data.id
karakeep.list / search data is an array; page for cursor
kanboard.create_task / get_task data.id, data.title, data.project_id
core.notify_send data.sent
core.agent_run data.reply
core.clip_create data includes public URL fields
core.http_request data.status, data.body
core.run_terminal / run_code data.output, data.exit_code
core.kv_get data is the stored value

Capabilities

Capability Reference
core capabilities/core.md — Core runtime primitives: notify, clip, agent, HTTP, sandboxed exec, and KV
devops capabilities/devops.md — DevOps aggregator for beszel, uptimekuma, traefik, grafana, wakapi, and dozzle
fireflyiii capabilities/fireflyiii.md — Finance capability for Firefly III
gitea capabilities/gitea.md — Forge capability
github capabilities/github.md — GitHub capability
kanboard capabilities/kanboard.md — Kanban capability
karakeep capabilities/karakeep.md — Bookmark capability
memos capabilities/memos.md — Memo capability for short-form note-taking
miniflux capabilities/miniflux.md — Reader capability
nocodb capabilities/nocodb.md — NocoDB bases, tables, and records
transmission capabilities/transmission.md — Download capability for Transmission
trilium capabilities/trilium.md — Note capability for note-taking systems