@stacklink/sdk 0.2.0 → 0.2.2

package/README.md

@@ -48,3 +48,13 @@ The complete Vercel, OpenAI Agents, and Claude Agent examples shown by the Stack
 The `withStacklinkMemory` exports for Vercel AI SDK, the raw OpenAI client, and OpenAI Agents remain separate Memory integrations. They do not replace the agent-tool adapters above and are not part of basic Overview onboarding.
 
 Exact tested versions are published in `@stacklink/sdk/compatibility.json`. The SDK is proprietary and is provided under the applicable Stacklink agreement.
+
+## Accepted operations, approvals and retries
+
+An execution response can be pending. Keep its `executionKind`, `executionId`, session ID and retry key in your application. Read or wait for that operation using the existing execution APIs. A lost connection does not submit a second action, and closing the application session can remove the authority required to execute pending work.
+
+Retry keys are case-sensitive and accept up to 240 characters. Tool and batch requests have separate key namespaces. Reuse a key only for the exact same request in the same SDK session. Changed inputs return `409 idempotency_key_reused`; an expired stored result returns `410 execution_result_expired`. Neither response authorizes submitting the write again.
+
+For `waiting_for_approval`, your backend can use the session approval read, approve and deny APIs with `platform_approvals:read` / `platform_approvals:manage` scopes. Keep the API key on your backend. A pending action must not be labelled completed. `provider_execution_result_unknown` means an external write may have happened; inspect the provider before considering another action.
+
+Use execution cancellation for an explicit Stop request. Losing a stream only stops observation. Vercel and LangChain adapters forward their supported abort signal; other adapters keep the structured operation identity available for explicit cancellation. MCP progress reports actual stages, not invented percentages.

package/compatibility.json

@@ -1,6 +1,6 @@
 {
   "schemaVersion": 1,
-  "sdkVersion": "0.2.0",
+  "sdkVersion": "0.2.2",
   "node": ">=22.0.0",
   "tested": {
     "ai": "7.0.31",