vilvona 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (812) hide show
  1. package/CHANGELOG.md +12331 -0
  2. package/LICENSE +24 -0
  3. package/README.md +314 -0
  4. package/THIRD_PARTY_NOTICES.md +37 -0
  5. package/docs/.i18n/README.md +81 -0
  6. package/docs/.i18n/ar-navigation.json +18 -0
  7. package/docs/.i18n/de-navigation.json +18 -0
  8. package/docs/.i18n/es-navigation.json +18 -0
  9. package/docs/.i18n/fr-navigation.json +18 -0
  10. package/docs/.i18n/glossary.ar.json +82 -0
  11. package/docs/.i18n/glossary.de.json +82 -0
  12. package/docs/.i18n/glossary.es.json +82 -0
  13. package/docs/.i18n/glossary.fa.json +82 -0
  14. package/docs/.i18n/glossary.fr.json +82 -0
  15. package/docs/.i18n/glossary.id.json +82 -0
  16. package/docs/.i18n/glossary.it.json +82 -0
  17. package/docs/.i18n/glossary.ja-JP.json +102 -0
  18. package/docs/.i18n/glossary.ko.json +82 -0
  19. package/docs/.i18n/glossary.nl.json +82 -0
  20. package/docs/.i18n/glossary.pl.json +82 -0
  21. package/docs/.i18n/glossary.pt-BR.json +82 -0
  22. package/docs/.i18n/glossary.th.json +82 -0
  23. package/docs/.i18n/glossary.tr.json +82 -0
  24. package/docs/.i18n/glossary.uk.json +82 -0
  25. package/docs/.i18n/glossary.vi.json +82 -0
  26. package/docs/.i18n/glossary.zh-CN.json +1182 -0
  27. package/docs/.i18n/glossary.zh-TW.json +162 -0
  28. package/docs/.i18n/id-navigation.json +18 -0
  29. package/docs/.i18n/it-navigation.json +18 -0
  30. package/docs/.i18n/ja-navigation.json +18 -0
  31. package/docs/.i18n/ko-navigation.json +18 -0
  32. package/docs/.i18n/pl-navigation.json +18 -0
  33. package/docs/.i18n/pt-BR-navigation.json +18 -0
  34. package/docs/.i18n/tr-navigation.json +18 -0
  35. package/docs/.i18n/translation-workflow.md +111 -0
  36. package/docs/.i18n/zh-Hans-navigation.json +552 -0
  37. package/docs/AGENTS.md +36 -0
  38. package/docs/agent-runtime-architecture.md +48 -0
  39. package/docs/announcements/bluebubbles-imessage.md +79 -0
  40. package/docs/auth-credential-semantics.md +124 -0
  41. package/docs/automation/auth-monitoring.md +11 -0
  42. package/docs/automation/clawflow.md +12 -0
  43. package/docs/automation/cron-jobs.md +569 -0
  44. package/docs/automation/cron-vs-heartbeat.md +11 -0
  45. package/docs/automation/gmail-pubsub.md +11 -0
  46. package/docs/automation/hooks.md +387 -0
  47. package/docs/automation/index.md +135 -0
  48. package/docs/automation/poll.md +12 -0
  49. package/docs/automation/standing-orders.md +250 -0
  50. package/docs/automation/taskflow.md +155 -0
  51. package/docs/automation/tasks.md +374 -0
  52. package/docs/automation/troubleshooting.md +12 -0
  53. package/docs/automation/webhook.md +12 -0
  54. package/docs/brave-search.md +11 -0
  55. package/docs/channels/access-groups.md +201 -0
  56. package/docs/channels/ambient-room-events.md +214 -0
  57. package/docs/channels/bot-loop-protection.md +131 -0
  58. package/docs/channels/broadcast-groups.md +472 -0
  59. package/docs/channels/channel-routing.md +162 -0
  60. package/docs/channels/clickclack.md +146 -0
  61. package/docs/channels/discord.md +1758 -0
  62. package/docs/channels/feishu.md +654 -0
  63. package/docs/channels/googlechat.md +286 -0
  64. package/docs/channels/group-messages.md +95 -0
  65. package/docs/channels/groups.md +610 -0
  66. package/docs/channels/imessage-from-bluebubbles.md +259 -0
  67. package/docs/channels/imessage.md +864 -0
  68. package/docs/channels/index.md +65 -0
  69. package/docs/channels/irc.md +253 -0
  70. package/docs/channels/line.md +243 -0
  71. package/docs/channels/location.md +71 -0
  72. package/docs/channels/matrix-migration.md +375 -0
  73. package/docs/channels/matrix-presentation.md +77 -0
  74. package/docs/channels/matrix-push-rules.md +150 -0
  75. package/docs/channels/matrix.md +935 -0
  76. package/docs/channels/mattermost.md +542 -0
  77. package/docs/channels/msteams.md +1097 -0
  78. package/docs/channels/nextcloud-talk.md +176 -0
  79. package/docs/channels/nostr.md +253 -0
  80. package/docs/channels/pairing.md +214 -0
  81. package/docs/channels/qqbot.md +317 -0
  82. package/docs/channels/signal.md +417 -0
  83. package/docs/channels/slack.md +1623 -0
  84. package/docs/channels/sms.md +380 -0
  85. package/docs/channels/synology-chat.md +187 -0
  86. package/docs/channels/telegram.md +1121 -0
  87. package/docs/channels/tlon.md +296 -0
  88. package/docs/channels/troubleshooting.md +162 -0
  89. package/docs/channels/twitch.md +431 -0
  90. package/docs/channels/wechat.md +171 -0
  91. package/docs/channels/whatsapp.md +796 -0
  92. package/docs/channels/yuanbao.md +416 -0
  93. package/docs/channels/zalo.md +253 -0
  94. package/docs/channels/zalouser.md +217 -0
  95. package/docs/ci.md +665 -0
  96. package/docs/clawhub/cli.md +82 -0
  97. package/docs/clawhub/publishing.md +96 -0
  98. package/docs/cli/acp.md +370 -0
  99. package/docs/cli/agent.md +109 -0
  100. package/docs/cli/agents.md +253 -0
  101. package/docs/cli/approvals.md +193 -0
  102. package/docs/cli/backup.md +98 -0
  103. package/docs/cli/browser.md +322 -0
  104. package/docs/cli/channels.md +154 -0
  105. package/docs/cli/clawbot.md +25 -0
  106. package/docs/cli/commitments.md +90 -0
  107. package/docs/cli/completion.md +39 -0
  108. package/docs/cli/config.md +504 -0
  109. package/docs/cli/configure.md +77 -0
  110. package/docs/cli/crestodian.md +337 -0
  111. package/docs/cli/cron.md +344 -0
  112. package/docs/cli/daemon.md +67 -0
  113. package/docs/cli/dashboard.md +33 -0
  114. package/docs/cli/devices.md +240 -0
  115. package/docs/cli/directory.md +68 -0
  116. package/docs/cli/dns.md +53 -0
  117. package/docs/cli/docs.md +63 -0
  118. package/docs/cli/doctor.md +254 -0
  119. package/docs/cli/flows.md +52 -0
  120. package/docs/cli/gateway.md +572 -0
  121. package/docs/cli/health.md +43 -0
  122. package/docs/cli/hooks.md +345 -0
  123. package/docs/cli/index.md +406 -0
  124. package/docs/cli/infer.md +364 -0
  125. package/docs/cli/logs.md +68 -0
  126. package/docs/cli/mcp.md +851 -0
  127. package/docs/cli/memory.md +183 -0
  128. package/docs/cli/message.md +317 -0
  129. package/docs/cli/migrate.md +334 -0
  130. package/docs/cli/models.md +239 -0
  131. package/docs/cli/node.md +178 -0
  132. package/docs/cli/nodes.md +76 -0
  133. package/docs/cli/onboard.md +251 -0
  134. package/docs/cli/pairing.md +77 -0
  135. package/docs/cli/path.md +511 -0
  136. package/docs/cli/plugins.md +480 -0
  137. package/docs/cli/policy.md +929 -0
  138. package/docs/cli/proxy.md +89 -0
  139. package/docs/cli/qr.md +56 -0
  140. package/docs/cli/reset.md +39 -0
  141. package/docs/cli/sandbox.md +208 -0
  142. package/docs/cli/secrets.md +202 -0
  143. package/docs/cli/security.md +135 -0
  144. package/docs/cli/sessions.md +178 -0
  145. package/docs/cli/setup.md +60 -0
  146. package/docs/cli/skills.md +156 -0
  147. package/docs/cli/status.md +45 -0
  148. package/docs/cli/system.md +89 -0
  149. package/docs/cli/tasks.md +111 -0
  150. package/docs/cli/transcripts.md +151 -0
  151. package/docs/cli/tui.md +92 -0
  152. package/docs/cli/uninstall.md +45 -0
  153. package/docs/cli/update.md +283 -0
  154. package/docs/cli/voicecall.md +204 -0
  155. package/docs/cli/webhooks.md +117 -0
  156. package/docs/cli/wiki.md +256 -0
  157. package/docs/cli/workboard.md +228 -0
  158. package/docs/concepts/active-memory.md +856 -0
  159. package/docs/concepts/agent-loop.md +185 -0
  160. package/docs/concepts/agent-runtimes.md +276 -0
  161. package/docs/concepts/agent-workspace.md +230 -0
  162. package/docs/concepts/agent.md +142 -0
  163. package/docs/concepts/architecture.md +154 -0
  164. package/docs/concepts/channel-docking.md +145 -0
  165. package/docs/concepts/commitments.md +150 -0
  166. package/docs/concepts/compaction.md +203 -0
  167. package/docs/concepts/context-engine.md +347 -0
  168. package/docs/concepts/context.md +199 -0
  169. package/docs/concepts/delegate-architecture.md +319 -0
  170. package/docs/concepts/dreaming.md +279 -0
  171. package/docs/concepts/experimental-features.md +111 -0
  172. package/docs/concepts/features.md +91 -0
  173. package/docs/concepts/mantis-slack-desktop-runbook.md +231 -0
  174. package/docs/concepts/mantis.md +744 -0
  175. package/docs/concepts/markdown-formatting.md +139 -0
  176. package/docs/concepts/memory-builtin.md +151 -0
  177. package/docs/concepts/memory-honcho.md +144 -0
  178. package/docs/concepts/memory-qmd.md +277 -0
  179. package/docs/concepts/memory-search.md +175 -0
  180. package/docs/concepts/memory.md +299 -0
  181. package/docs/concepts/message-lifecycle-refactor.md +1126 -0
  182. package/docs/concepts/messages.md +216 -0
  183. package/docs/concepts/model-failover.md +405 -0
  184. package/docs/concepts/model-providers.md +719 -0
  185. package/docs/concepts/models.md +371 -0
  186. package/docs/concepts/multi-agent.md +625 -0
  187. package/docs/concepts/oauth.md +218 -0
  188. package/docs/concepts/parallel-specialist-lanes.md +127 -0
  189. package/docs/concepts/personal-agent-benchmark-pack.md +74 -0
  190. package/docs/concepts/presence.md +117 -0
  191. package/docs/concepts/progress-drafts.md +406 -0
  192. package/docs/concepts/qa-e2e-automation.md +979 -0
  193. package/docs/concepts/qa-matrix.md +139 -0
  194. package/docs/concepts/queue-steering.md +90 -0
  195. package/docs/concepts/queue.md +136 -0
  196. package/docs/concepts/retry.md +86 -0
  197. package/docs/concepts/session-pruning.md +104 -0
  198. package/docs/concepts/session-tool.md +201 -0
  199. package/docs/concepts/session.md +164 -0
  200. package/docs/concepts/soul.md +116 -0
  201. package/docs/concepts/streaming.md +258 -0
  202. package/docs/concepts/system-prompt.md +330 -0
  203. package/docs/concepts/timezone.md +47 -0
  204. package/docs/concepts/typebox.md +309 -0
  205. package/docs/concepts/typing-indicators.md +88 -0
  206. package/docs/concepts/usage-tracking.md +72 -0
  207. package/docs/date-time.md +126 -0
  208. package/docs/debug/node-issue.md +90 -0
  209. package/docs/diagnostics/flags.md +182 -0
  210. package/docs/docs.json +1885 -0
  211. package/docs/gateway/authentication.md +286 -0
  212. package/docs/gateway/background-process.md +147 -0
  213. package/docs/gateway/bonjour.md +303 -0
  214. package/docs/gateway/bridge-protocol.md +97 -0
  215. package/docs/gateway/cli-backends.md +463 -0
  216. package/docs/gateway/config-agents.md +1525 -0
  217. package/docs/gateway/config-channels.md +942 -0
  218. package/docs/gateway/config-tools.md +806 -0
  219. package/docs/gateway/configuration-examples.md +706 -0
  220. package/docs/gateway/configuration-reference.md +1449 -0
  221. package/docs/gateway/configuration.md +748 -0
  222. package/docs/gateway/diagnostics.md +213 -0
  223. package/docs/gateway/discovery.md +154 -0
  224. package/docs/gateway/doctor.md +576 -0
  225. package/docs/gateway/external-apps.md +86 -0
  226. package/docs/gateway/gateway-lock.md +37 -0
  227. package/docs/gateway/health.md +73 -0
  228. package/docs/gateway/heartbeat.md +498 -0
  229. package/docs/gateway/index.md +385 -0
  230. package/docs/gateway/local-model-services.md +205 -0
  231. package/docs/gateway/local-models.md +355 -0
  232. package/docs/gateway/logging.md +149 -0
  233. package/docs/gateway/multiple-gateways.md +178 -0
  234. package/docs/gateway/network-model.md +15 -0
  235. package/docs/gateway/openai-http-api.md +379 -0
  236. package/docs/gateway/openresponses-http-api.md +349 -0
  237. package/docs/gateway/openshell.md +316 -0
  238. package/docs/gateway/opentelemetry.md +440 -0
  239. package/docs/gateway/operator-scopes.md +119 -0
  240. package/docs/gateway/pairing.md +207 -0
  241. package/docs/gateway/prometheus.md +249 -0
  242. package/docs/gateway/protocol.md +839 -0
  243. package/docs/gateway/remote-gateway-readme.md +169 -0
  244. package/docs/gateway/remote.md +280 -0
  245. package/docs/gateway/sandbox-vs-tool-policy-vs-elevated.md +148 -0
  246. package/docs/gateway/sandboxing.md +546 -0
  247. package/docs/gateway/secrets-plan-contract.md +159 -0
  248. package/docs/gateway/secrets.md +805 -0
  249. package/docs/gateway/security/audit-checks.md +127 -0
  250. package/docs/gateway/security/exposure-runbook.md +212 -0
  251. package/docs/gateway/security/index.md +1344 -0
  252. package/docs/gateway/security/secure-file-operations.md +76 -0
  253. package/docs/gateway/security/shrinkwrap.md +111 -0
  254. package/docs/gateway/tailscale.md +180 -0
  255. package/docs/gateway/tools-invoke-http-api.md +175 -0
  256. package/docs/gateway/troubleshooting.md +881 -0
  257. package/docs/gateway/trusted-proxy-auth.md +483 -0
  258. package/docs/help/debugging.md +341 -0
  259. package/docs/help/environment.md +240 -0
  260. package/docs/help/faq-first-run.md +872 -0
  261. package/docs/help/faq-models.md +557 -0
  262. package/docs/help/faq.md +2115 -0
  263. package/docs/help/index.md +39 -0
  264. package/docs/help/scripts.md +56 -0
  265. package/docs/help/testing-live.md +592 -0
  266. package/docs/help/testing-updates-plugins.md +299 -0
  267. package/docs/help/testing.md +977 -0
  268. package/docs/help/troubleshooting.md +500 -0
  269. package/docs/index.md +196 -0
  270. package/docs/install/ansible.md +233 -0
  271. package/docs/install/azure.md +315 -0
  272. package/docs/install/bun.md +59 -0
  273. package/docs/install/clawdock.md +112 -0
  274. package/docs/install/development-channels.md +148 -0
  275. package/docs/install/digitalocean.md +174 -0
  276. package/docs/install/docker-vm-runtime.md +154 -0
  277. package/docs/install/docker.md +564 -0
  278. package/docs/install/exe-dev.md +201 -0
  279. package/docs/install/fly.md +524 -0
  280. package/docs/install/gcp.md +418 -0
  281. package/docs/install/hetzner.md +285 -0
  282. package/docs/install/hostinger.md +98 -0
  283. package/docs/install/index.md +236 -0
  284. package/docs/install/installer.md +447 -0
  285. package/docs/install/kubernetes.md +196 -0
  286. package/docs/install/macos-vm.md +281 -0
  287. package/docs/install/migrating-claude.md +165 -0
  288. package/docs/install/migrating-hermes.md +178 -0
  289. package/docs/install/migrating.md +137 -0
  290. package/docs/install/nix.md +112 -0
  291. package/docs/install/node.md +142 -0
  292. package/docs/install/northflank.mdx +44 -0
  293. package/docs/install/oracle.md +218 -0
  294. package/docs/install/podman.md +216 -0
  295. package/docs/install/railway.mdx +92 -0
  296. package/docs/install/raspberry-pi.md +234 -0
  297. package/docs/install/render.mdx +167 -0
  298. package/docs/install/uninstall.md +140 -0
  299. package/docs/install/updating.md +284 -0
  300. package/docs/install/upstash.md +96 -0
  301. package/docs/logging.md +322 -0
  302. package/docs/maturity-scores.yaml +5361 -0
  303. package/docs/nav-tabs-underline.js +104 -0
  304. package/docs/network.md +72 -0
  305. package/docs/nodes/audio.md +216 -0
  306. package/docs/nodes/camera.md +166 -0
  307. package/docs/nodes/images.md +77 -0
  308. package/docs/nodes/index.md +444 -0
  309. package/docs/nodes/location-command.md +102 -0
  310. package/docs/nodes/media-understanding.md +495 -0
  311. package/docs/nodes/talk.md +160 -0
  312. package/docs/nodes/troubleshooting.md +123 -0
  313. package/docs/nodes/voicewake.md +93 -0
  314. package/docs/openclaw-agent-runtime.md +82 -0
  315. package/docs/perplexity.md +11 -0
  316. package/docs/plan/codex-context-engine-harness.md +624 -0
  317. package/docs/plan/ui-channels.md +284 -0
  318. package/docs/platforms/android.md +286 -0
  319. package/docs/platforms/digitalocean.md +12 -0
  320. package/docs/platforms/easyrunner.md +109 -0
  321. package/docs/platforms/index.md +65 -0
  322. package/docs/platforms/ios.md +287 -0
  323. package/docs/platforms/linux.md +141 -0
  324. package/docs/platforms/mac/bundled-gateway.md +79 -0
  325. package/docs/platforms/mac/canvas.md +128 -0
  326. package/docs/platforms/mac/child-process.md +72 -0
  327. package/docs/platforms/mac/dev-setup.md +112 -0
  328. package/docs/platforms/mac/health.md +39 -0
  329. package/docs/platforms/mac/icon.md +36 -0
  330. package/docs/platforms/mac/logging.md +62 -0
  331. package/docs/platforms/mac/menu-bar.md +93 -0
  332. package/docs/platforms/mac/peekaboo.md +96 -0
  333. package/docs/platforms/mac/permissions.md +73 -0
  334. package/docs/platforms/mac/remote.md +123 -0
  335. package/docs/platforms/mac/signing.md +52 -0
  336. package/docs/platforms/mac/skills.md +45 -0
  337. package/docs/platforms/mac/voice-overlay.md +66 -0
  338. package/docs/platforms/mac/voicewake.md +79 -0
  339. package/docs/platforms/mac/webchat.md +54 -0
  340. package/docs/platforms/mac/xpc.md +66 -0
  341. package/docs/platforms/macos.md +228 -0
  342. package/docs/platforms/oracle.md +12 -0
  343. package/docs/platforms/raspberry-pi.md +13 -0
  344. package/docs/platforms/windows.md +304 -0
  345. package/docs/plugins/adding-capabilities.md +146 -0
  346. package/docs/plugins/admin-http-rpc.md +216 -0
  347. package/docs/plugins/agent-tools.md +13 -0
  348. package/docs/plugins/architecture-internals.md +1203 -0
  349. package/docs/plugins/architecture.md +483 -0
  350. package/docs/plugins/building-extensions.md +13 -0
  351. package/docs/plugins/building-plugins.md +343 -0
  352. package/docs/plugins/bundles.md +310 -0
  353. package/docs/plugins/cli-backend-plugins.md +328 -0
  354. package/docs/plugins/codex-computer-use.md +297 -0
  355. package/docs/plugins/codex-harness-reference.md +480 -0
  356. package/docs/plugins/codex-harness-runtime.md +268 -0
  357. package/docs/plugins/codex-harness.md +800 -0
  358. package/docs/plugins/codex-native-plugins.md +280 -0
  359. package/docs/plugins/community.md +77 -0
  360. package/docs/plugins/compatibility.md +198 -0
  361. package/docs/plugins/copilot.md +355 -0
  362. package/docs/plugins/dependency-resolution.md +176 -0
  363. package/docs/plugins/google-meet.md +1737 -0
  364. package/docs/plugins/hooks.md +525 -0
  365. package/docs/plugins/install-overrides.md +80 -0
  366. package/docs/plugins/llama-cpp.md +58 -0
  367. package/docs/plugins/manage-plugins.md +214 -0
  368. package/docs/plugins/manifest.md +1468 -0
  369. package/docs/plugins/memory-lancedb.md +385 -0
  370. package/docs/plugins/memory-wiki.md +529 -0
  371. package/docs/plugins/message-presentation.md +487 -0
  372. package/docs/plugins/oc-path.md +166 -0
  373. package/docs/plugins/plugin-inventory.md +318 -0
  374. package/docs/plugins/plugin-permission-requests.md +193 -0
  375. package/docs/plugins/reference/acpx.md +23 -0
  376. package/docs/plugins/reference/admin-http-rpc.md +23 -0
  377. package/docs/plugins/reference/alibaba.md +23 -0
  378. package/docs/plugins/reference/amazon-bedrock-mantle.md +23 -0
  379. package/docs/plugins/reference/amazon-bedrock.md +23 -0
  380. package/docs/plugins/reference/anthropic-vertex.md +29 -0
  381. package/docs/plugins/reference/anthropic.md +23 -0
  382. package/docs/plugins/reference/arcee.md +23 -0
  383. package/docs/plugins/reference/azure-speech.md +23 -0
  384. package/docs/plugins/reference/bonjour.md +19 -0
  385. package/docs/plugins/reference/brave.md +23 -0
  386. package/docs/plugins/reference/browser.md +23 -0
  387. package/docs/plugins/reference/byteplus.md +19 -0
  388. package/docs/plugins/reference/canvas.md +19 -0
  389. package/docs/plugins/reference/cerebras.md +23 -0
  390. package/docs/plugins/reference/chutes.md +23 -0
  391. package/docs/plugins/reference/clickclack.md +23 -0
  392. package/docs/plugins/reference/cloudflare-ai-gateway.md +23 -0
  393. package/docs/plugins/reference/codex-supervisor.md +27 -0
  394. package/docs/plugins/reference/codex.md +23 -0
  395. package/docs/plugins/reference/comfy.md +23 -0
  396. package/docs/plugins/reference/copilot-proxy.md +19 -0
  397. package/docs/plugins/reference/copilot.md +23 -0
  398. package/docs/plugins/reference/deepgram.md +23 -0
  399. package/docs/plugins/reference/deepinfra.md +23 -0
  400. package/docs/plugins/reference/deepseek.md +23 -0
  401. package/docs/plugins/reference/diagnostics-otel.md +19 -0
  402. package/docs/plugins/reference/diagnostics-prometheus.md +19 -0
  403. package/docs/plugins/reference/diffs-language-pack.md +31 -0
  404. package/docs/plugins/reference/diffs.md +19 -0
  405. package/docs/plugins/reference/discord.md +23 -0
  406. package/docs/plugins/reference/document-extract.md +23 -0
  407. package/docs/plugins/reference/duckduckgo.md +23 -0
  408. package/docs/plugins/reference/elevenlabs.md +23 -0
  409. package/docs/plugins/reference/exa.md +23 -0
  410. package/docs/plugins/reference/fal.md +23 -0
  411. package/docs/plugins/reference/feishu.md +23 -0
  412. package/docs/plugins/reference/file-transfer.md +19 -0
  413. package/docs/plugins/reference/firecrawl.md +23 -0
  414. package/docs/plugins/reference/fireworks.md +23 -0
  415. package/docs/plugins/reference/github-copilot.md +23 -0
  416. package/docs/plugins/reference/gmi.md +23 -0
  417. package/docs/plugins/reference/google-meet.md +23 -0
  418. package/docs/plugins/reference/google.md +23 -0
  419. package/docs/plugins/reference/googlechat.md +23 -0
  420. package/docs/plugins/reference/gradium.md +23 -0
  421. package/docs/plugins/reference/groq.md +23 -0
  422. package/docs/plugins/reference/huggingface.md +23 -0
  423. package/docs/plugins/reference/imessage.md +23 -0
  424. package/docs/plugins/reference/inworld.md +23 -0
  425. package/docs/plugins/reference/irc.md +23 -0
  426. package/docs/plugins/reference/kilocode.md +23 -0
  427. package/docs/plugins/reference/kimi.md +23 -0
  428. package/docs/plugins/reference/line.md +23 -0
  429. package/docs/plugins/reference/litellm.md +23 -0
  430. package/docs/plugins/reference/llama-cpp.md +23 -0
  431. package/docs/plugins/reference/llm-task.md +19 -0
  432. package/docs/plugins/reference/lmstudio.md +23 -0
  433. package/docs/plugins/reference/lobster.md +19 -0
  434. package/docs/plugins/reference/matrix.md +23 -0
  435. package/docs/plugins/reference/mattermost.md +23 -0
  436. package/docs/plugins/reference/memory-core.md +19 -0
  437. package/docs/plugins/reference/memory-lancedb.md +23 -0
  438. package/docs/plugins/reference/memory-wiki.md +23 -0
  439. package/docs/plugins/reference/microsoft-foundry.md +113 -0
  440. package/docs/plugins/reference/microsoft.md +19 -0
  441. package/docs/plugins/reference/migrate-claude.md +19 -0
  442. package/docs/plugins/reference/migrate-hermes.md +19 -0
  443. package/docs/plugins/reference/minimax.md +23 -0
  444. package/docs/plugins/reference/mistral.md +23 -0
  445. package/docs/plugins/reference/moonshot.md +23 -0
  446. package/docs/plugins/reference/msteams.md +23 -0
  447. package/docs/plugins/reference/nextcloud-talk.md +23 -0
  448. package/docs/plugins/reference/nostr.md +23 -0
  449. package/docs/plugins/reference/novita.md +23 -0
  450. package/docs/plugins/reference/nvidia.md +23 -0
  451. package/docs/plugins/reference/oc-path.md +23 -0
  452. package/docs/plugins/reference/ollama.md +24 -0
  453. package/docs/plugins/reference/open-prose.md +19 -0
  454. package/docs/plugins/reference/openai.md +23 -0
  455. package/docs/plugins/reference/opencode-go.md +23 -0
  456. package/docs/plugins/reference/opencode.md +23 -0
  457. package/docs/plugins/reference/openrouter.md +23 -0
  458. package/docs/plugins/reference/openshell.md +19 -0
  459. package/docs/plugins/reference/perplexity.md +23 -0
  460. package/docs/plugins/reference/pixverse.md +23 -0
  461. package/docs/plugins/reference/policy.md +79 -0
  462. package/docs/plugins/reference/qa-channel.md +23 -0
  463. package/docs/plugins/reference/qa-lab.md +19 -0
  464. package/docs/plugins/reference/qa-matrix.md +19 -0
  465. package/docs/plugins/reference/qianfan.md +23 -0
  466. package/docs/plugins/reference/qqbot.md +23 -0
  467. package/docs/plugins/reference/qwen.md +24 -0
  468. package/docs/plugins/reference/runway.md +23 -0
  469. package/docs/plugins/reference/searxng.md +19 -0
  470. package/docs/plugins/reference/senseaudio.md +23 -0
  471. package/docs/plugins/reference/sglang.md +23 -0
  472. package/docs/plugins/reference/signal.md +23 -0
  473. package/docs/plugins/reference/slack.md +23 -0
  474. package/docs/plugins/reference/sms.md +23 -0
  475. package/docs/plugins/reference/stepfun.md +23 -0
  476. package/docs/plugins/reference/synology-chat.md +23 -0
  477. package/docs/plugins/reference/synthetic.md +23 -0
  478. package/docs/plugins/reference/tavily.md +23 -0
  479. package/docs/plugins/reference/telegram.md +23 -0
  480. package/docs/plugins/reference/tencent.md +23 -0
  481. package/docs/plugins/reference/tlon.md +23 -0
  482. package/docs/plugins/reference/together.md +23 -0
  483. package/docs/plugins/reference/tokenjuice.md +23 -0
  484. package/docs/plugins/reference/tts-local-cli.md +19 -0
  485. package/docs/plugins/reference/twitch.md +23 -0
  486. package/docs/plugins/reference/venice.md +23 -0
  487. package/docs/plugins/reference/vercel-ai-gateway.md +23 -0
  488. package/docs/plugins/reference/vllm.md +23 -0
  489. package/docs/plugins/reference/voice-call.md +23 -0
  490. package/docs/plugins/reference/volcengine.md +23 -0
  491. package/docs/plugins/reference/voyage.md +19 -0
  492. package/docs/plugins/reference/vydra.md +23 -0
  493. package/docs/plugins/reference/web-readability.md +19 -0
  494. package/docs/plugins/reference/webhooks.md +23 -0
  495. package/docs/plugins/reference/whatsapp.md +23 -0
  496. package/docs/plugins/reference/workboard.md +23 -0
  497. package/docs/plugins/reference/xai.md +23 -0
  498. package/docs/plugins/reference/xiaomi.md +23 -0
  499. package/docs/plugins/reference/zai.md +23 -0
  500. package/docs/plugins/reference/zalo.md +23 -0
  501. package/docs/plugins/reference/zalouser.md +24 -0
  502. package/docs/plugins/reference.md +19 -0
  503. package/docs/plugins/sdk-agent-harness.md +339 -0
  504. package/docs/plugins/sdk-channel-inbound.md +70 -0
  505. package/docs/plugins/sdk-channel-ingress.md +137 -0
  506. package/docs/plugins/sdk-channel-message.md +18 -0
  507. package/docs/plugins/sdk-channel-outbound.md +113 -0
  508. package/docs/plugins/sdk-channel-plugins.md +770 -0
  509. package/docs/plugins/sdk-channel-turn.md +9 -0
  510. package/docs/plugins/sdk-entrypoints.md +344 -0
  511. package/docs/plugins/sdk-migration.md +1011 -0
  512. package/docs/plugins/sdk-overview.md +525 -0
  513. package/docs/plugins/sdk-provider-plugins.md +1019 -0
  514. package/docs/plugins/sdk-runtime.md +683 -0
  515. package/docs/plugins/sdk-setup.md +550 -0
  516. package/docs/plugins/sdk-subpaths.md +401 -0
  517. package/docs/plugins/sdk-testing.md +403 -0
  518. package/docs/plugins/tool-plugins.md +411 -0
  519. package/docs/plugins/voice-call.md +942 -0
  520. package/docs/plugins/webhooks.md +192 -0
  521. package/docs/plugins/workboard.md +402 -0
  522. package/docs/plugins/zalouser.md +86 -0
  523. package/docs/prose.md +191 -0
  524. package/docs/providers/alibaba.md +158 -0
  525. package/docs/providers/anthropic.md +386 -0
  526. package/docs/providers/arcee.md +144 -0
  527. package/docs/providers/azure-speech.md +119 -0
  528. package/docs/providers/bedrock-mantle.md +224 -0
  529. package/docs/providers/bedrock.md +433 -0
  530. package/docs/providers/cerebras.md +130 -0
  531. package/docs/providers/chutes.md +153 -0
  532. package/docs/providers/claude-max-api-proxy.md +191 -0
  533. package/docs/providers/cloudflare-ai-gateway.md +119 -0
  534. package/docs/providers/comfy.md +362 -0
  535. package/docs/providers/deepgram.md +184 -0
  536. package/docs/providers/deepinfra.md +92 -0
  537. package/docs/providers/deepseek.md +146 -0
  538. package/docs/providers/ds4.md +309 -0
  539. package/docs/providers/elevenlabs.md +130 -0
  540. package/docs/providers/fal.md +240 -0
  541. package/docs/providers/fireworks.md +144 -0
  542. package/docs/providers/github-copilot.md +257 -0
  543. package/docs/providers/gmi.md +92 -0
  544. package/docs/providers/google.md +472 -0
  545. package/docs/providers/gradium.md +123 -0
  546. package/docs/providers/groq.md +171 -0
  547. package/docs/providers/huggingface.md +235 -0
  548. package/docs/providers/index.md +105 -0
  549. package/docs/providers/inferrs.md +272 -0
  550. package/docs/providers/inworld.md +120 -0
  551. package/docs/providers/kilocode.md +135 -0
  552. package/docs/providers/litellm.md +234 -0
  553. package/docs/providers/lmstudio.md +224 -0
  554. package/docs/providers/minimax.md +518 -0
  555. package/docs/providers/mistral.md +235 -0
  556. package/docs/providers/models.md +64 -0
  557. package/docs/providers/moonshot.md +413 -0
  558. package/docs/providers/novita.md +92 -0
  559. package/docs/providers/nvidia.md +208 -0
  560. package/docs/providers/ollama-cloud.md +115 -0
  561. package/docs/providers/ollama.md +1225 -0
  562. package/docs/providers/openai.md +1091 -0
  563. package/docs/providers/opencode-go.md +123 -0
  564. package/docs/providers/opencode.md +149 -0
  565. package/docs/providers/openrouter.md +390 -0
  566. package/docs/providers/perplexity-provider.md +123 -0
  567. package/docs/providers/pixverse.md +165 -0
  568. package/docs/providers/qianfan.md +132 -0
  569. package/docs/providers/qwen-oauth.md +115 -0
  570. package/docs/providers/qwen.md +364 -0
  571. package/docs/providers/runway.md +103 -0
  572. package/docs/providers/senseaudio.md +68 -0
  573. package/docs/providers/sglang.md +161 -0
  574. package/docs/providers/stepfun.md +229 -0
  575. package/docs/providers/synthetic.md +154 -0
  576. package/docs/providers/tencent.md +130 -0
  577. package/docs/providers/together.md +140 -0
  578. package/docs/providers/venice.md +312 -0
  579. package/docs/providers/vercel-ai-gateway.md +128 -0
  580. package/docs/providers/vllm.md +407 -0
  581. package/docs/providers/volcengine.md +199 -0
  582. package/docs/providers/vydra.md +180 -0
  583. package/docs/providers/xai.md +571 -0
  584. package/docs/providers/xiaomi.md +286 -0
  585. package/docs/providers/zai.md +224 -0
  586. package/docs/refactor/access.md +9 -0
  587. package/docs/refactor/acp.md +298 -0
  588. package/docs/refactor/canvas.md +131 -0
  589. package/docs/refactor/database-first.md +2263 -0
  590. package/docs/refactor/ingress-core.md +341 -0
  591. package/docs/reference/AGENTS.default.md +131 -0
  592. package/docs/reference/RELEASING.md +844 -0
  593. package/docs/reference/api-usage-costs.md +208 -0
  594. package/docs/reference/application-modernization-plan.md +208 -0
  595. package/docs/reference/code-mode.md +1058 -0
  596. package/docs/reference/credits.md +33 -0
  597. package/docs/reference/device-models.md +50 -0
  598. package/docs/reference/full-release-validation.md +206 -0
  599. package/docs/reference/memory-config.md +630 -0
  600. package/docs/reference/prompt-caching.md +358 -0
  601. package/docs/reference/release-performance-sweep.md +347 -0
  602. package/docs/reference/rich-output-protocol.md +93 -0
  603. package/docs/reference/rpc.md +43 -0
  604. package/docs/reference/secret-placeholder-conventions.md +33 -0
  605. package/docs/reference/secretref-credential-surface.md +163 -0
  606. package/docs/reference/secretref-user-supplied-credentials-matrix.json +691 -0
  607. package/docs/reference/session-management-compaction.md +474 -0
  608. package/docs/reference/templates/AGENTS.dev.md +90 -0
  609. package/docs/reference/templates/AGENTS.md +227 -0
  610. package/docs/reference/templates/BOOT.md +16 -0
  611. package/docs/reference/templates/BOOTSTRAP.md +66 -0
  612. package/docs/reference/templates/HEARTBEAT.md +24 -0
  613. package/docs/reference/templates/IDENTITY.dev.md +52 -0
  614. package/docs/reference/templates/IDENTITY.md +34 -0
  615. package/docs/reference/templates/SOUL.dev.md +82 -0
  616. package/docs/reference/templates/SOUL.md +49 -0
  617. package/docs/reference/templates/TOOLS.dev.md +29 -0
  618. package/docs/reference/templates/TOOLS.md +51 -0
  619. package/docs/reference/templates/USER.dev.md +23 -0
  620. package/docs/reference/templates/USER.md +28 -0
  621. package/docs/reference/test.md +248 -0
  622. package/docs/reference/token-use.md +246 -0
  623. package/docs/reference/transcript-hygiene.md +226 -0
  624. package/docs/reference/wizard.md +252 -0
  625. package/docs/security/CONTRIBUTING-THREAT-MODEL.md +101 -0
  626. package/docs/security/THREAT-MODEL-ATLAS.md +611 -0
  627. package/docs/security/formal-verification.md +170 -0
  628. package/docs/security/incident-response.md +59 -0
  629. package/docs/security/network-proxy.md +268 -0
  630. package/docs/snippets/plugin-publish/minimal-openclaw.plugin.json +12 -0
  631. package/docs/snippets/plugin-publish/minimal-package.json +16 -0
  632. package/docs/specs/claw-supervisor.md +247 -0
  633. package/docs/start/bootstrapping.md +49 -0
  634. package/docs/start/docs-directory.md +69 -0
  635. package/docs/start/getting-started.md +152 -0
  636. package/docs/start/hubs.md +201 -0
  637. package/docs/start/lore.md +223 -0
  638. package/docs/start/onboarding-overview.md +72 -0
  639. package/docs/start/onboarding.md +98 -0
  640. package/docs/start/openclaw.md +246 -0
  641. package/docs/start/quickstart.md +25 -0
  642. package/docs/start/setup.md +178 -0
  643. package/docs/start/showcase.md +371 -0
  644. package/docs/start/wizard-cli-automation.md +232 -0
  645. package/docs/start/wizard-cli-reference.md +331 -0
  646. package/docs/start/wizard.md +142 -0
  647. package/docs/style.css +137 -0
  648. package/docs/tools/acp-agents-setup.md +356 -0
  649. package/docs/tools/acp-agents.md +865 -0
  650. package/docs/tools/agent-send.md +130 -0
  651. package/docs/tools/apply-patch.md +64 -0
  652. package/docs/tools/brave-search.md +139 -0
  653. package/docs/tools/browser-control.md +405 -0
  654. package/docs/tools/browser-linux-troubleshooting.md +173 -0
  655. package/docs/tools/browser-login.md +77 -0
  656. package/docs/tools/browser-wsl2-windows-remote-cdp-troubleshooting.md +219 -0
  657. package/docs/tools/browser.md +866 -0
  658. package/docs/tools/btw.md +159 -0
  659. package/docs/tools/capability-cookbook.md +12 -0
  660. package/docs/tools/clawhub.md +5 -0
  661. package/docs/tools/code-execution.md +173 -0
  662. package/docs/tools/creating-skills.md +271 -0
  663. package/docs/tools/diffs.md +527 -0
  664. package/docs/tools/duckduckgo-search.md +109 -0
  665. package/docs/tools/elevated.md +128 -0
  666. package/docs/tools/exa-search.md +152 -0
  667. package/docs/tools/exec-approvals-advanced.md +457 -0
  668. package/docs/tools/exec-approvals.md +520 -0
  669. package/docs/tools/exec.md +294 -0
  670. package/docs/tools/firecrawl.md +155 -0
  671. package/docs/tools/gemini-search.md +114 -0
  672. package/docs/tools/goal.md +217 -0
  673. package/docs/tools/grok-search.md +129 -0
  674. package/docs/tools/image-generation.md +538 -0
  675. package/docs/tools/index.md +176 -0
  676. package/docs/tools/kimi-search.md +105 -0
  677. package/docs/tools/llm-task.md +137 -0
  678. package/docs/tools/lobster.md +365 -0
  679. package/docs/tools/loop-detection.md +154 -0
  680. package/docs/tools/media-overview.md +161 -0
  681. package/docs/tools/minimax-search.md +102 -0
  682. package/docs/tools/multi-agent-sandbox-tools.md +409 -0
  683. package/docs/tools/music-generation.md +372 -0
  684. package/docs/tools/ollama-search.md +153 -0
  685. package/docs/tools/parallel-search.md +154 -0
  686. package/docs/tools/pdf.md +213 -0
  687. package/docs/tools/permission-modes.md +111 -0
  688. package/docs/tools/perplexity-search.md +220 -0
  689. package/docs/tools/plugin.md +378 -0
  690. package/docs/tools/reactions.md +100 -0
  691. package/docs/tools/searxng-search.md +141 -0
  692. package/docs/tools/skill-workshop.md +283 -0
  693. package/docs/tools/skills-config.md +457 -0
  694. package/docs/tools/skills.md +591 -0
  695. package/docs/tools/slash-commands.md +518 -0
  696. package/docs/tools/steer.md +77 -0
  697. package/docs/tools/subagents.md +652 -0
  698. package/docs/tools/tavily.md +162 -0
  699. package/docs/tools/thinking.md +142 -0
  700. package/docs/tools/tokenjuice.md +84 -0
  701. package/docs/tools/tool-search.md +269 -0
  702. package/docs/tools/trajectory.md +229 -0
  703. package/docs/tools/tts.md +1013 -0
  704. package/docs/tools/video-generation.md +555 -0
  705. package/docs/tools/web-fetch.md +210 -0
  706. package/docs/tools/web.md +476 -0
  707. package/docs/tts.md +11 -0
  708. package/docs/vps.md +139 -0
  709. package/docs/web/control-ui.md +530 -0
  710. package/docs/web/dashboard.md +107 -0
  711. package/docs/web/index.md +133 -0
  712. package/docs/web/tui.md +258 -0
  713. package/docs/web/webchat.md +102 -0
  714. package/npm-shrinkwrap.json +3485 -0
  715. package/openclaw.mjs +661 -0
  716. package/package.json +1971 -0
  717. package/patches/.gitkeep +0 -0
  718. package/patches/@agentclientprotocol__claude-agent-acp@0.39.0.patch +40 -0
  719. package/pnpm-workspace.yaml +124 -0
  720. package/scripts/crabbox-wrapper.mjs +2470 -0
  721. package/scripts/lib/official-external-channel-catalog.json +570 -0
  722. package/scripts/lib/official-external-plugin-catalog.json +284 -0
  723. package/scripts/lib/official-external-provider-catalog.json +158 -0
  724. package/scripts/lib/package-dist-imports.mjs +174 -0
  725. package/scripts/npm-runner.mjs +95 -0
  726. package/scripts/postinstall-bundled-plugins.mjs +978 -0
  727. package/scripts/preinstall-package-manager-warning.mjs +74 -0
  728. package/scripts/prepare-git-hooks.mjs +73 -0
  729. package/scripts/windows-cmd-helpers.mjs +29 -0
  730. package/skills/1password/SKILL.md +70 -0
  731. package/skills/1password/references/cli-examples.md +29 -0
  732. package/skills/1password/references/get-started.md +17 -0
  733. package/skills/apple-notes/SKILL.md +77 -0
  734. package/skills/apple-reminders/SKILL.md +118 -0
  735. package/skills/bear-notes/SKILL.md +107 -0
  736. package/skills/blogwatcher/SKILL.md +69 -0
  737. package/skills/blucli/SKILL.md +47 -0
  738. package/skills/camsnap/SKILL.md +45 -0
  739. package/skills/canvas/SKILL.md +78 -0
  740. package/skills/clawhub/SKILL.md +77 -0
  741. package/skills/coding-agent/SKILL.md +143 -0
  742. package/skills/diagram-maker/SKILL.md +53 -0
  743. package/skills/diagram-maker/references/excalidraw-patterns.md +85 -0
  744. package/skills/diagram-maker/references/svg-template.md +112 -0
  745. package/skills/discord/SKILL.md +136 -0
  746. package/skills/eightctl/SKILL.md +50 -0
  747. package/skills/gemini/SKILL.md +47 -0
  748. package/skills/gh-issues/SKILL.md +213 -0
  749. package/skills/gifgrep/SKILL.md +85 -0
  750. package/skills/github/SKILL.md +84 -0
  751. package/skills/gog/SKILL.md +116 -0
  752. package/skills/goplaces/SKILL.md +52 -0
  753. package/skills/healthcheck/SKILL.md +105 -0
  754. package/skills/himalaya/SKILL.md +80 -0
  755. package/skills/himalaya/references/configuration.md +184 -0
  756. package/skills/himalaya/references/message-composition.md +199 -0
  757. package/skills/imsg/SKILL.md +122 -0
  758. package/skills/mcporter/SKILL.md +61 -0
  759. package/skills/meme-maker/SKILL.md +42 -0
  760. package/skills/meme-maker/references/templates.json +358 -0
  761. package/skills/meme-maker/scripts/meme.mjs +398 -0
  762. package/skills/model-usage/SKILL.md +71 -0
  763. package/skills/model-usage/references/codexbar-cli.md +33 -0
  764. package/skills/model-usage/scripts/model_usage.py +319 -0
  765. package/skills/model-usage/scripts/test_model_usage.py +40 -0
  766. package/skills/nano-pdf/SKILL.md +38 -0
  767. package/skills/node-connect/SKILL.md +143 -0
  768. package/skills/node-inspect-debugger/SKILL.md +85 -0
  769. package/skills/notion/SKILL.md +150 -0
  770. package/skills/obsidian/SKILL.md +119 -0
  771. package/skills/openai-whisper/SKILL.md +38 -0
  772. package/skills/openai-whisper-api/SKILL.md +71 -0
  773. package/skills/openai-whisper-api/scripts/transcribe.sh +154 -0
  774. package/skills/openhue/SKILL.md +112 -0
  775. package/skills/oracle/SKILL.md +126 -0
  776. package/skills/ordercli/SKILL.md +78 -0
  777. package/skills/peekaboo/SKILL.md +198 -0
  778. package/skills/pyproject.toml +10 -0
  779. package/skills/python-debugpy/SKILL.md +73 -0
  780. package/skills/sag/SKILL.md +87 -0
  781. package/skills/session-logs/SKILL.md +151 -0
  782. package/skills/sherpa-onnx-tts/SKILL.md +109 -0
  783. package/skills/sherpa-onnx-tts/bin/sherpa-onnx-tts +178 -0
  784. package/skills/skill-creator/SKILL.md +78 -0
  785. package/skills/skill-creator/license.txt +202 -0
  786. package/skills/skill-creator/scripts/init_skill.py +378 -0
  787. package/skills/skill-creator/scripts/package_skill.py +144 -0
  788. package/skills/skill-creator/scripts/quick_validate.py +169 -0
  789. package/skills/skill-creator/scripts/test_package_skill.py +199 -0
  790. package/skills/skill-creator/scripts/test_quick_validate.py +116 -0
  791. package/skills/slack/SKILL.md +78 -0
  792. package/skills/songsee/SKILL.md +49 -0
  793. package/skills/sonoscli/SKILL.md +65 -0
  794. package/skills/spike/SKILL.md +51 -0
  795. package/skills/spotify-player/SKILL.md +64 -0
  796. package/skills/summarize/SKILL.md +87 -0
  797. package/skills/taskflow/SKILL.md +149 -0
  798. package/skills/taskflow/examples/inbox-triage.lobster +33 -0
  799. package/skills/taskflow/examples/pr-intake.lobster +32 -0
  800. package/skills/taskflow-inbox-triage/SKILL.md +119 -0
  801. package/skills/things-mac/SKILL.md +86 -0
  802. package/skills/tmux/SKILL.md +91 -0
  803. package/skills/tmux/scripts/find-sessions.sh +112 -0
  804. package/skills/tmux/scripts/wait-for-text.sh +83 -0
  805. package/skills/trello/SKILL.md +108 -0
  806. package/skills/video-frames/SKILL.md +46 -0
  807. package/skills/video-frames/scripts/frame.sh +81 -0
  808. package/skills/voice-call/SKILL.md +45 -0
  809. package/skills/wacli/SKILL.md +72 -0
  810. package/skills/weather/SKILL.md +87 -0
  811. package/skills/xurl/SKILL.md +120 -0
  812. package/src/agents/templates/HEARTBEAT.md +5 -0
@@ -0,0 +1,339 @@
1
+ ---
2
+ summary: "Experimental SDK surface for plugins that replace the low level embedded agent executor"
3
+ title: "Agent harness plugins"
4
+ sidebarTitle: "Agent Harness"
5
+ read_when:
6
+ - You are changing the embedded agent runtime or harness registry
7
+ - You are registering an agent harness from a bundled or trusted plugin
8
+ - You need to understand how the Codex plugin relates to model providers
9
+ ---
10
+
11
+ An **agent harness** is the low level executor for one prepared OpenClaw agent
12
+ turn. It is not a model provider, not a channel, and not a tool registry.
13
+ For the user-facing mental model, see [Agent runtimes](/concepts/agent-runtimes).
14
+
15
+ Use this surface only for bundled or trusted native plugins. The contract is
16
+ still experimental because the parameter types intentionally mirror the current
17
+ embedded runner.
18
+
19
+ ## When to use a harness
20
+
21
+ Register an agent harness when a model family has its own native session
22
+ runtime and the normal OpenClaw provider transport is the wrong abstraction.
23
+
24
+ Examples:
25
+
26
+ - a native coding-agent server that owns threads and compaction
27
+ - a local CLI or daemon that must stream native plan/reasoning/tool events
28
+ - a model runtime that needs its own resume id in addition to the OpenClaw
29
+ session transcript
30
+
31
+ Do **not** register a harness just to add a new LLM API. For normal HTTP or
32
+ WebSocket model APIs, build a [provider plugin](/plugins/sdk-provider-plugins).
33
+
34
+ ## What core still owns
35
+
36
+ Before a harness is selected, OpenClaw has already resolved:
37
+
38
+ - provider and model
39
+ - runtime auth state
40
+ - thinking level and context budget
41
+ - the OpenClaw transcript/session file
42
+ - workspace, sandbox, and tool policy
43
+ - channel reply callbacks and streaming callbacks
44
+ - model fallback and live model switching policy
45
+
46
+ That split is intentional. A harness runs a prepared attempt; it does not pick
47
+ providers, replace channel delivery, or silently switch models.
48
+
49
+ The prepared attempt also includes `params.runtimePlan`, an OpenClaw-owned
50
+ policy bundle for runtime decisions that must stay shared across OpenClaw and native
51
+ harnesses:
52
+
53
+ - `runtimePlan.tools.normalize(...)` and
54
+ `runtimePlan.tools.logDiagnostics(...)` for provider-aware tool schema policy
55
+ - `runtimePlan.transcript.resolvePolicy(...)` for transcript sanitization and
56
+ tool-call repair policy
57
+ - `runtimePlan.delivery.isSilentPayload(...)` for shared `NO_REPLY` and media
58
+ delivery suppression
59
+ - `runtimePlan.outcome.classifyRunResult(...)` for model fallback classification
60
+ - `runtimePlan.observability` for resolved provider/model/harness metadata
61
+
62
+ Harnesses may use the plan for decisions that need to match OpenClaw behavior, but
63
+ should still treat it as host-owned attempt state. Do not mutate it or use it to
64
+ switch providers/models inside a turn.
65
+
66
+ ## Register a harness
67
+
68
+ **Import:** `openclaw/plugin-sdk/agent-harness`
69
+
70
+ ```typescript
71
+ import type { AgentHarness } from "openclaw/plugin-sdk/agent-harness";
72
+ import { definePluginEntry } from "openclaw/plugin-sdk/plugin-entry";
73
+
74
+ const myHarness: AgentHarness = {
75
+ id: "my-harness",
76
+ label: "My native agent harness",
77
+
78
+ supports(ctx) {
79
+ return ctx.provider === "my-provider"
80
+ ? { supported: true, priority: 100 }
81
+ : { supported: false };
82
+ },
83
+
84
+ async runAttempt(params) {
85
+ // Start or resume your native thread.
86
+ // Use params.prompt, params.tools, params.images, params.onPartialReply,
87
+ // params.onAgentEvent, and the other prepared attempt fields.
88
+ return await runMyNativeTurn(params);
89
+ },
90
+ };
91
+
92
+ export default definePluginEntry({
93
+ id: "my-native-agent",
94
+ name: "My Native Agent",
95
+ description: "Runs selected models through a native agent daemon.",
96
+ register(api) {
97
+ api.registerAgentHarness(myHarness);
98
+ },
99
+ });
100
+ ```
101
+
102
+ ## Selection policy
103
+
104
+ OpenClaw chooses a harness after provider/model resolution:
105
+
106
+ 1. Model-scoped runtime policy wins.
107
+ 2. Provider-scoped runtime policy comes next.
108
+ 3. `auto` asks registered harnesses if they support the resolved
109
+ provider/model.
110
+ 4. If no registered harness matches, OpenClaw uses its embedded runtime.
111
+
112
+ Plugin harness failures surface as run failures. In `auto` mode, embedded fallback is
113
+ only used when no registered plugin harness supports the resolved
114
+ provider/model. Once a plugin harness has claimed a run, OpenClaw does not
115
+ replay that same turn through another runtime because that can change
116
+ auth/runtime semantics or duplicate side effects.
117
+
118
+ Whole-session and whole-agent runtime pins are ignored by selection. That
119
+ includes stale session `agentHarnessId` values, `agents.defaults.agentRuntime`,
120
+ `agents.list[].agentRuntime`, and `OPENCLAW_AGENT_RUNTIME`. `/status` shows the
121
+ effective runtime selected from the provider/model route.
122
+ If the selected harness is surprising, enable `agents/harness` debug logging and
123
+ inspect the gateway's structured `agent harness selected` record. It includes
124
+ the selected harness id, selection reason, runtime/fallback policy, and, in
125
+ `auto` mode, each plugin candidate's support result.
126
+
127
+ The bundled Codex plugin registers `codex` as its harness id. Core treats that
128
+ as an ordinary plugin harness id; Codex-specific aliases belong in the plugin
129
+ or operator config, not in the shared runtime selector.
130
+
131
+ ## Provider plus harness pairing
132
+
133
+ Most harnesses should also register a provider. The provider makes model refs,
134
+ auth status, model metadata, and `/model` selection visible to the rest of
135
+ OpenClaw. The harness then claims that provider in `supports(...)`.
136
+
137
+ The bundled Codex plugin follows this pattern:
138
+
139
+ - preferred user model refs: `openai/gpt-5.5`
140
+ - compatibility refs: legacy `codex/gpt-*` refs remain accepted, but new
141
+ configs should not use them as normal provider/model refs
142
+ - harness id: `codex`
143
+ - auth: synthetic provider availability, because the Codex harness owns the
144
+ native Codex login/session
145
+ - app-server request: OpenClaw sends the bare model id to Codex and lets the
146
+ harness talk to the native app-server protocol
147
+
148
+ The Codex plugin is additive. Plain `openai/gpt-*` agent refs on the official
149
+ OpenAI provider select the Codex harness by default. Older `codex/gpt-*` refs
150
+ still select the Codex provider and harness for compatibility.
151
+
152
+ For operator setup, model prefix examples, and Codex-only configs, see
153
+ [Codex Harness](/plugins/codex-harness).
154
+
155
+ OpenClaw requires Codex app-server `0.125.0` or newer. The Codex plugin checks
156
+ the app-server initialize handshake and blocks older or unversioned servers so
157
+ OpenClaw only runs against the protocol surface it has been tested with. The
158
+ `0.125.0` floor includes the native MCP hook payload support that landed in
159
+ Codex `0.124.0`, while pinning OpenClaw to the newer tested stable line.
160
+
161
+ ### Tool-result middleware
162
+
163
+ Bundled plugins and explicitly enabled installed plugins with matching manifest
164
+ contracts can attach runtime-neutral tool-result middleware through
165
+ `api.registerAgentToolResultMiddleware(...)` when their manifest declares the
166
+ targeted runtime ids in `contracts.agentToolResultMiddleware`. This trusted
167
+ seam is for async tool-result transforms that must run before OpenClaw or Codex
168
+ feeds tool output back into the model.
169
+
170
+ Legacy bundled plugins can still use
171
+ `api.registerCodexAppServerExtensionFactory(...)` for Codex app-server-only
172
+ middleware, but new result transforms should use the runtime-neutral API.
173
+ The embedded-runner-only `api.registerEmbeddedExtensionFactory(...)` hook has been removed;
174
+ embedded tool-result transforms must use runtime-neutral middleware.
175
+
176
+ ### Terminal outcome classification
177
+
178
+ Native harnesses that own their own protocol projection can use
179
+ `classifyAgentHarnessTerminalOutcome(...)` from
180
+ `openclaw/plugin-sdk/agent-harness-runtime` when a completed turn produced no
181
+ visible assistant text. The helper returns `empty`, `reasoning-only`, or
182
+ `planning-only` so OpenClaw's fallback policy can decide whether to retry on a
183
+ different model. It intentionally leaves prompt errors, in-flight turns, and
184
+ intentional silent replies such as `NO_REPLY` unclassified.
185
+
186
+ ### Native Codex harness mode
187
+
188
+ The bundled `codex` harness is the native Codex mode for embedded OpenClaw
189
+ agent turns. Enable the bundled `codex` plugin first, and include `codex` in
190
+ `plugins.allow` if your config uses a restrictive allowlist. Native app-server
191
+ configs should use `openai/gpt-*`; OpenAI agent turns select the Codex harness
192
+ by default. Legacy Codex model refs routes should be repaired with
193
+ `openclaw doctor --fix`, and legacy `codex/*` model refs remain compatibility
194
+ aliases for the native harness.
195
+
196
+ When this mode runs, Codex owns the native thread id, resume behavior,
197
+ compaction, and app-server execution. OpenClaw still owns the chat channel,
198
+ visible transcript mirror, tool policy, approvals, media delivery, and session
199
+ selection. Use provider/model `agentRuntime.id: "codex"` when you need to prove
200
+ that only the Codex app-server path can claim the run. Explicit plugin runtimes
201
+ fail closed; Codex app-server selection failures and runtime failures are not
202
+ retried through another runtime.
203
+
204
+ ## Runtime strictness
205
+
206
+ By default, OpenClaw uses `auto` provider/model runtime policy: registered
207
+ plugin harnesses can claim a provider/model pair, and the embedded runtime
208
+ handles the turn when none match. OpenAI agent refs on the official OpenAI provider default to Codex.
209
+ Use an explicit provider/model plugin runtime such as
210
+ `agentRuntime.id: "codex"` when missing harness selection should fail instead
211
+ of routing through the embedded runtime. Selected plugin harness failures always
212
+ fail hard. This does not block an explicit provider/model `agentRuntime.id: "openclaw"`.
213
+
214
+ For Codex-only embedded runs:
215
+
216
+ ```json
217
+ {
218
+ "models": {
219
+ "providers": {
220
+ "openai": {
221
+ "agentRuntime": {
222
+ "id": "codex"
223
+ }
224
+ }
225
+ }
226
+ },
227
+ "agents": {
228
+ "defaults": {
229
+ "model": "openai/gpt-5.5"
230
+ }
231
+ }
232
+ }
233
+ ```
234
+
235
+ If you want a CLI backend for one canonical model, put the runtime on that
236
+ model entry:
237
+
238
+ ```json
239
+ {
240
+ "agents": {
241
+ "defaults": {
242
+ "model": "anthropic/claude-opus-4-8",
243
+ "models": {
244
+ "anthropic/claude-opus-4-8": {
245
+ "agentRuntime": {
246
+ "id": "claude-cli"
247
+ }
248
+ }
249
+ }
250
+ }
251
+ }
252
+ }
253
+ ```
254
+
255
+ Per-agent overrides use the same model-scoped shape:
256
+
257
+ ```json
258
+ {
259
+ "agents": {
260
+ "list": [
261
+ {
262
+ "id": "codex-only",
263
+ "model": "openai/gpt-5.5",
264
+ "models": {
265
+ "openai/gpt-5.5": {
266
+ "agentRuntime": { "id": "codex" }
267
+ }
268
+ }
269
+ }
270
+ ]
271
+ }
272
+ }
273
+ ```
274
+
275
+ Legacy whole-agent runtime examples like this are ignored:
276
+
277
+ ```json
278
+ {
279
+ "agents": {
280
+ "defaults": {
281
+ "agentRuntime": {
282
+ "id": "codex"
283
+ }
284
+ }
285
+ }
286
+ }
287
+ ```
288
+
289
+ With an explicit plugin runtime, a session fails early when the requested
290
+ harness is not registered, does not support the resolved provider/model, or
291
+ fails before producing turn side effects. That is intentional for Codex-only
292
+ deployments and for live tests that must prove the Codex app-server path is
293
+ actually in use.
294
+
295
+ This setting only controls the embedded agent harness. It does not disable
296
+ image, video, music, TTS, PDF, or other provider-specific model routing.
297
+
298
+ ## Native sessions and transcript mirror
299
+
300
+ A harness may keep a native session id, thread id, or daemon-side resume token.
301
+ Keep that binding explicitly associated with the OpenClaw session, and keep
302
+ mirroring user-visible assistant/tool output into the OpenClaw transcript.
303
+
304
+ The OpenClaw transcript remains the compatibility layer for:
305
+
306
+ - channel-visible session history
307
+ - transcript search and indexing
308
+ - switching back to the built-in OpenClaw harness on a later turn
309
+ - generic `/new`, `/reset`, and session deletion behavior
310
+
311
+ If your harness stores a sidecar binding, implement `reset(...)` so OpenClaw can
312
+ clear it when the owning OpenClaw session is reset.
313
+
314
+ ## Tool and media results
315
+
316
+ Core constructs the OpenClaw tool list and passes it into the prepared attempt.
317
+ When a harness executes a dynamic tool call, return the tool result back through
318
+ the harness result shape instead of sending channel media yourself.
319
+
320
+ This keeps text, image, video, music, TTS, approval, and messaging-tool outputs
321
+ on the same delivery path as OpenClaw-backed runs.
322
+
323
+ ## Current limitations
324
+
325
+ - The public import path is generic, but some attempt/result type aliases still
326
+ carry legacy names for compatibility.
327
+ - Third-party harness installation is experimental. Prefer provider plugins
328
+ until you need a native session runtime.
329
+ - Harness switching is supported across turns. Do not switch harnesses in the
330
+ middle of a turn after native tools, approvals, assistant text, or message
331
+ sends have started.
332
+
333
+ ## Related
334
+
335
+ - [SDK Overview](/plugins/sdk-overview)
336
+ - [Runtime Helpers](/plugins/sdk-runtime)
337
+ - [Provider Plugins](/plugins/sdk-provider-plugins)
338
+ - [Codex Harness](/plugins/codex-harness)
339
+ - [Model Providers](/concepts/model-providers)
@@ -0,0 +1,70 @@
1
+ ---
2
+ summary: "Inbound event helpers for channel plugins: context building, shared runner orchestration, session record, and prepared reply dispatch"
3
+ title: "Channel inbound API"
4
+ read_when:
5
+ - You are building or refactoring a messaging channel plugin receive path
6
+ - You need shared inbound context construction, session recording, or prepared reply dispatch
7
+ - You are migrating old channel turn helpers to inbound/message APIs
8
+ ---
9
+
10
+ Channel plugins should model receive paths with inbound and message nouns:
11
+
12
+ ```text
13
+ platform event -> inbound facts/context -> agent reply -> message delivery
14
+ ```
15
+
16
+ Use `openclaw/plugin-sdk/channel-inbound` for inbound event normalization,
17
+ formatting, roots, and orchestration. Use
18
+ `openclaw/plugin-sdk/channel-outbound` for native
19
+ send, receipt, durable delivery, and live preview behavior.
20
+
21
+ ## Core Helpers
22
+
23
+ ```ts
24
+ import {
25
+ buildChannelInboundEventContext,
26
+ runChannelInboundEvent,
27
+ dispatchChannelInboundReply,
28
+ } from "openclaw/plugin-sdk/channel-inbound";
29
+ ```
30
+
31
+ - `buildChannelInboundEventContext(...)`: project normalized channel facts into
32
+ the prompt/session context.
33
+ - `runChannelInboundEvent(...)`: run ingest, classify, preflight, resolve,
34
+ record, dispatch, and finalize for one inbound platform event.
35
+ - `dispatchChannelInboundReply(...)`: record and dispatch an already assembled
36
+ inbound reply with a delivery adapter.
37
+
38
+ The injected plugin runtime exposes the same high-level helpers under
39
+ `runtime.channel.inbound.*` for bundled/native channels that already receive the
40
+ runtime object.
41
+
42
+ ```ts
43
+ await runtime.channel.inbound.run({
44
+ channel: "demo",
45
+ accountId,
46
+ raw: platformEvent,
47
+ adapter: {
48
+ ingest: normalizePlatformEvent,
49
+ resolveTurn: resolveInboundReply,
50
+ },
51
+ });
52
+ ```
53
+
54
+ Compatibility dispatchers should assemble `dispatchChannelInboundReply(...)`
55
+ inputs and keep platform delivery in the delivery adapter. New send paths should
56
+ prefer message adapters and durable message helpers.
57
+
58
+ ## Migration
59
+
60
+ The old `runtime.channel.turn.*` runtime aliases were removed. Use:
61
+
62
+ - `runtime.channel.inbound.run(...)` for raw inbound events.
63
+ - `runtime.channel.inbound.dispatchReply(...)` for assembled reply contexts.
64
+ - `runtime.channel.inbound.buildContext(...)` for inbound context payloads.
65
+ - `runtime.channel.inbound.runPreparedReply(...)` only for channel-owned prepared
66
+ dispatch paths that already assemble their own dispatch closure.
67
+
68
+ New plugin code should not introduce `turn`-named channel APIs. Keep model or
69
+ agent turn vocabulary inside agent/provider code; channel plugins use inbound,
70
+ message, delivery, and reply terms.
@@ -0,0 +1,137 @@
1
+ ---
2
+ summary: "Experimental channel ingress API for inbound message authorization"
3
+ read_when:
4
+ - Building or migrating a messaging channel plugin
5
+ - Changing DM or group allowlists, route gates, command auth, event auth, or mention activation
6
+ - Reviewing channel ingress redaction or SDK compatibility boundaries
7
+ title: "Channel ingress API"
8
+ sidebarTitle: "Channel Ingress"
9
+ ---
10
+
11
+ # Channel ingress API
12
+
13
+ Channel ingress is the experimental access-control boundary for inbound channel
14
+ events. Use `openclaw/plugin-sdk/channel-ingress-runtime` for receive paths.
15
+ The older `openclaw/plugin-sdk/channel-ingress` subpath stays exported as a
16
+ deprecated compatibility facade for third-party plugins.
17
+
18
+ Plugins own platform facts and side effects. Core owns generic policy: DM/group
19
+ allowlists, pairing-store DM entries, route gates, command gates, event auth,
20
+ mention activation, redacted diagnostics, and admission.
21
+
22
+ ## Runtime Resolver
23
+
24
+ ```ts
25
+ import {
26
+ defineStableChannelIngressIdentity,
27
+ resolveChannelMessageIngress,
28
+ } from "openclaw/plugin-sdk/channel-ingress-runtime";
29
+
30
+ const identity = defineStableChannelIngressIdentity({
31
+ key: "platform-user-id",
32
+ normalize: normalizePlatformUserId,
33
+ sensitivity: "pii",
34
+ });
35
+
36
+ const result = await resolveChannelMessageIngress({
37
+ channelId: "my-channel",
38
+ accountId,
39
+ identity,
40
+ subject: { stableId: platformUserId },
41
+ conversation: { kind: isGroup ? "group" : "direct", id: conversationId },
42
+ event: { kind: "message", authMode: "inbound", mayPair: !isGroup },
43
+ policy: {
44
+ dmPolicy: config.dmPolicy,
45
+ groupPolicy: config.groupPolicy,
46
+ groupAllowFromFallbackToAllowFrom: true,
47
+ },
48
+ allowFrom: config.allowFrom,
49
+ groupAllowFrom: config.groupAllowFrom,
50
+ accessGroups: cfg.accessGroups,
51
+ route,
52
+ readStoreAllowFrom,
53
+ command: hasControlCommand ? { allowTextCommands: true, hasControlCommand } : undefined,
54
+ });
55
+ ```
56
+
57
+ Do not precompute effective allowlists, command owners, or command groups. The
58
+ resolver derives them from raw allowlists, store callbacks, route descriptors,
59
+ access groups, policy, and conversation kind.
60
+
61
+ ## Result
62
+
63
+ Bundled plugins should consume modern projections directly:
64
+
65
+ - `ingress`: ordered gate decision and admission
66
+ - `senderAccess`: sender/conversation authorization only
67
+ - `routeAccess`: route and route-sender projection
68
+ - `commandAccess`: command authorization; false when no command gate ran
69
+ - `activationAccess`: mention/activation result
70
+
71
+ Event authorization remains available on the ordered `ingress.graph` and the
72
+ decisive `ingress.reasonCode`; no separate event projection is emitted.
73
+
74
+ Deprecated third-party SDK helpers may rebuild older shapes internally. New
75
+ bundled receive paths should not translate modern results back into local DTOs.
76
+
77
+ ## Access Groups
78
+
79
+ `accessGroup:<name>` entries stay redacted. Core resolves static
80
+ `message.senders` groups itself and calls `resolveAccessGroupMembership` only
81
+ for dynamic groups that require a platform lookup. Missing, unsupported, and
82
+ failed groups fail closed.
83
+
84
+ ## Event Modes
85
+
86
+ | `authMode` | Meaning |
87
+ | ---------------- | ------------------------------------------------ |
88
+ | `inbound` | normal inbound sender gates |
89
+ | `command` | command gates for callbacks or scoped buttons |
90
+ | `origin-subject` | actor must match the original message subject |
91
+ | `route-only` | route gates only for route-scoped trusted events |
92
+ | `none` | plugin-owned internal events bypass shared auth |
93
+
94
+ Use `mayPair: false` for reactions, buttons, callbacks, and native commands.
95
+
96
+ ## Routes And Activation
97
+
98
+ Use route descriptors for room, topic, guild, thread, or nested route policy:
99
+
100
+ ```ts
101
+ route: {
102
+ id: "room",
103
+ allowed: roomAllowed,
104
+ enabled: roomEnabled,
105
+ senderPolicy: "replace",
106
+ senderAllowFrom: roomAllowFrom,
107
+ blockReason: "room_sender_not_allowlisted",
108
+ }
109
+ ```
110
+
111
+ Use `channelIngressRoutes(...)` when a plugin has several optional route
112
+ descriptors; it filters disabled branches while keeping route facts generic and
113
+ ordered by each descriptor's `precedence`.
114
+
115
+ Mention gating is an activation gate. A mention miss returns
116
+ `admission: "skip"` so the turn kernel does not process an observe-only turn.
117
+ Most channels should leave activation after sender and command gates. Public
118
+ chat surfaces that must quiet non-mentioned traffic before sender allowlist
119
+ noise can opt into `activation.order: "before-sender"` when text-command
120
+ bypass is disabled. Channels with implicit activation, such as replies in bot
121
+ threads, can pass `activation.allowedImplicitMentionKinds`; the projected
122
+ `activationAccess.shouldBypassMention` then reports when command or implicit
123
+ activation bypassed an explicit mention.
124
+
125
+ ## Redaction
126
+
127
+ Raw sender values and raw allowlist entries are resolver input only. They must
128
+ not appear in resolved state, decisions, diagnostics, snapshots, or
129
+ compatibility facts. Use opaque subject ids, entry ids, route ids, and
130
+ diagnostic ids.
131
+
132
+ ## Verification
133
+
134
+ ```bash
135
+ pnpm test src/channels/message-access/message-access.test.ts src/plugin-sdk/channel-ingress-runtime.test.ts
136
+ pnpm plugin-sdk:api:check
137
+ ```
@@ -0,0 +1,18 @@
1
+ ---
2
+ summary: "Redirect to /plugins/sdk-channel-outbound"
3
+ title: "Channel message API"
4
+ ---
5
+
6
+ This page moved to [Channel outbound API](/plugins/sdk-channel-outbound).
7
+
8
+ `openclaw/plugin-sdk/channel-message` and
9
+ `openclaw/plugin-sdk/channel-message-runtime` remain deprecated compatibility
10
+ subpaths for older plugins. New channel plugins should use
11
+ `openclaw/plugin-sdk/channel-outbound` for message lifecycle, receipt, durable
12
+ send, and live preview helpers. The deprecated subpaths are thin aliases over
13
+ the shared channel message core and the focused inbound/outbound SDK surfaces;
14
+ do not add new helpers there.
15
+
16
+ Removal plan: keep these aliases through the external plugin migration window,
17
+ then remove them in the next major SDK cleanup after callers have moved to
18
+ `channel-outbound`.
@@ -0,0 +1,113 @@
1
+ ---
2
+ summary: "Outbound message lifecycle API for channel plugins: adapters, receipts, durable sends, live preview, and reply pipeline helpers"
3
+ title: "Channel outbound API"
4
+ read_when:
5
+ - You are building or refactoring a messaging channel plugin send path
6
+ - You need durable final reply delivery, receipts, live preview finalization, or receive acknowledgement policy
7
+ - You are migrating from channel-message, channel-message-runtime, or legacy reply dispatch helpers
8
+ ---
9
+
10
+ Channel plugins should expose outbound message behavior from
11
+ `openclaw/plugin-sdk/channel-outbound`. Use
12
+ `openclaw/plugin-sdk/channel-inbound` for receive/context/dispatch orchestration.
13
+
14
+ Core owns queueing, durability, generic retry policy, hooks, receipts, and the
15
+ shared `message` tool. The plugin owns native send/edit/delete calls, target
16
+ normalization, platform threading, selected quotes, notification flags, account
17
+ state, and platform-specific side effects.
18
+
19
+ ## Adapter
20
+
21
+ Most plugins define one `message` adapter:
22
+
23
+ ```ts
24
+ import {
25
+ defineChannelMessageAdapter,
26
+ createMessageReceiptFromOutboundResults,
27
+ } from "openclaw/plugin-sdk/channel-outbound";
28
+
29
+ export const demoMessageAdapter = defineChannelMessageAdapter({
30
+ id: "demo",
31
+ durableFinal: {
32
+ capabilities: {
33
+ text: true,
34
+ replyTo: true,
35
+ thread: true,
36
+ messageSendingHooks: true,
37
+ },
38
+ },
39
+ send: {
40
+ text: async ({ cfg, to, text, accountId, replyToId, threadId, signal }) => {
41
+ const sent = await sendDemoMessage({
42
+ cfg,
43
+ to,
44
+ text,
45
+ accountId: accountId ?? undefined,
46
+ replyToId: replyToId ?? undefined,
47
+ threadId: threadId == null ? undefined : String(threadId),
48
+ signal,
49
+ });
50
+
51
+ return {
52
+ receipt: createMessageReceiptFromOutboundResults({
53
+ results: [{ channel: "demo", messageId: sent.id, conversationId: to }],
54
+ kind: "text",
55
+ threadId: threadId == null ? undefined : String(threadId),
56
+ replyToId: replyToId ?? undefined,
57
+ }),
58
+ };
59
+ },
60
+ },
61
+ });
62
+ ```
63
+
64
+ Only declare capabilities the native transport actually preserves. Cover each
65
+ declared send, receipt, live-preview, and receive-ack capability with the
66
+ contract helpers exported from this subpath.
67
+
68
+ ## Existing Outbound Adapters
69
+
70
+ If the channel already has a compatible `outbound` adapter, derive the message
71
+ adapter instead of duplicating send code:
72
+
73
+ ```ts
74
+ import { createChannelMessageAdapterFromOutbound } from "openclaw/plugin-sdk/channel-outbound";
75
+
76
+ export const messageAdapter = createChannelMessageAdapterFromOutbound({
77
+ id: "demo",
78
+ outbound,
79
+ durableFinal: {
80
+ capabilities: {
81
+ text: true,
82
+ media: true,
83
+ },
84
+ },
85
+ });
86
+ ```
87
+
88
+ ## Durable Sends
89
+
90
+ Runtime send helpers also live on `channel-outbound`:
91
+
92
+ - `sendDurableMessageBatch(...)`
93
+ - `withDurableMessageSendContext(...)`
94
+ - `deliverInboundReplyWithMessageSendContext(...)`
95
+ - draft streaming/progress helpers such as `resolveChannelDraftStreamingChunking(...)`
96
+
97
+ `sendDurableMessageBatch(...)` returns one explicit outcome:
98
+
99
+ - `sent`: at least one visible platform message was delivered.
100
+ - `suppressed`: no platform message should be treated as missing.
101
+ - `partial_failed`: at least one platform message was delivered before a later
102
+ payload or side effect failed.
103
+ - `failed`: no platform receipt was produced.
104
+
105
+ Use `payloadOutcomes` when a batch mixes sent, suppressed, and failed payloads.
106
+ Do not infer hook cancellation from an empty legacy direct-delivery result.
107
+
108
+ ## Compatibility Dispatch
109
+
110
+ Inbound reply dispatch should be assembled through
111
+ `dispatchChannelInboundReply(...)` from `channel-inbound`. Keep platform
112
+ delivery in the delivery adapter; use `channel-outbound` for message adapters,
113
+ durable sends, receipts, live preview, and reply pipeline options.