@@ -1,17 +1,24 @@
11---
2-summary: "Design proposal for a public OpenClaw app SDK for agent runs, sessions, tasks, artifacts, and managed environments"
3-title: "OpenClaw SDK design"
2+summary: "Public OpenClaw App SDK design for external apps, scripts, dashboards, CI jobs, and IDE extensions"
3+title: "OpenClaw App SDK"
4+sidebarTitle: "App SDK"
45read_when:
56 - You are designing or implementing a public OpenClaw app SDK
67 - You are comparing OpenClaw agent APIs with Cursor, Claude Agent SDK, OpenAI Agents, Google ADK, OpenCode, Codex, or ACP
7- - You need to decide whether a feature belongs in the public app SDK, plugin SDK, Gateway protocol, ACP backend, or managed environment layer
8+ - You need to decide whether a feature belongs in the public App SDK, Plugin SDK, Gateway protocol, ACP backend, or managed environment layer
89---
91010-This page is a design proposal for a future public **OpenClaw app SDK**. It is
11-separate from the existing [plugin SDK](/plugins/sdk-overview).
11+This page is a design proposal for the public **OpenClaw App SDK**. It is
12+separate from the existing [Plugin SDK](/plugins/sdk-overview).
121313-The plugin SDK is for code that runs inside OpenClaw and extends providers,
14-channels, tools, hooks, and trusted runtimes. The app SDK should be for
14+<Note>
15+ Use `@openclaw/sdk` when an external app, script, dashboard, CI job, or IDE
16+ extension wants to run and observe OpenClaw agents through the Gateway. Use
17+`openclaw/plugin-sdk/*` only when writing a plugin that runs inside OpenClaw.
18+</Note>
19+20+The Plugin SDK is for code that runs inside OpenClaw and extends providers,
21+channels, tools, hooks, and trusted runtimes. The App SDK should be for
1522external applications, scripts, dashboards, CI jobs, IDE extensions, and
1623automation systems that want to run and observe OpenClaw agents through a stable
1724public API.
@@ -231,7 +238,7 @@ agent is a normal run in a managed environment, not a special product fork.
231238232239The detailed namespace, event, result, approval, artifact, security, package,
233240and environment provider contracts live in
234-[OpenClaw SDK API design](/reference/openclaw-sdk-api-design).
241+[OpenClaw App SDK API design](/reference/openclaw-sdk-api-design).
235242236243## Cookbook plan
237244@@ -262,7 +269,7 @@ client examples belong in an advanced section.
262269- Agree on public nouns and names.
263270- Decide package names.
264271- Define the first event taxonomy.
265-- Mark the current plugin SDK as intentionally separate in docs.
272+- Mark the current Plugin SDK as intentionally separate in docs.
266273267274### Phase 1: Low-level generated client
268275@@ -330,7 +337,7 @@ Copy these ideas:
330337Avoid these traps:
331338332339- A public SDK that is just a thin dump of Gateway internals.
333-- A public SDK that imports plugin SDK subpaths.
340+- A public SDK that imports Plugin SDK subpaths.
334341- A public SDK where events are only `stream` plus `data`.
335342- A cloud-first API that makes local OpenClaw feel like a legacy mode.
336343- Runtime selection hidden in model id prefixes.
此内容由惯性聚合(RSS阅读器)自动聚合整理，仅供阅读参考。 原文来自 — 版权归原作者所有。