harivansh-afk/sandbox-agent
1
0
Fork 0
mirror of https://github.com/harivansh-afk/sandbox-agent.git synced 2026-04-20 13:02:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix: correct doc examples with valid Codex modes and update stable API list

Browse source 
- Replace invalid Codex mode values ("plan", "build") with valid ones
  ("auto", "full-access") in agent-sessions.mdx and sdk-overview.mdx
- Update CLAUDE.md stable method enumerations to include new session
  config methods (setSessionMode, setSessionModel, etc.)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Nathan Flurry 2026-03-05 23:08:58 -08:00
parent 971689ed6e
commit 0d0bb8b0e4
3 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

4
CLAUDE.md
View file

@ -54,8 +54,8 @@
- `acp-http-client`: protocol-pure ACP-over-HTTP (`/v1/acp`) with no Sandbox-specific HTTP helpers. - `acp-http-client`: protocol-pure ACP-over-HTTP (`/v1/acp`) with no Sandbox-specific HTTP helpers.
- `sandbox-agent`: `SandboxAgent` SDK wrapper that combines ACP session operations with Sandbox control-plane and filesystem helpers. - `sandbox-agent`: `SandboxAgent` SDK wrapper that combines ACP session operations with Sandbox control-plane and filesystem helpers.
- `SandboxAgent` entry points are `SandboxAgent.connect(...)` and `SandboxAgent.start(...)`. - `SandboxAgent` entry points are `SandboxAgent.connect(...)` and `SandboxAgent.start(...)`.
- Stable Sandbox session methods are `createSession`, `resumeSession`, `resumeOrCreateSession`, `destroySession`, `sendSessionMethod`, and `onSessionEvent`. - Stable Sandbox session methods are `createSession`, `resumeSession`, `resumeOrCreateSession`, `destroySession`, `sendSessionMethod`, `onSessionEvent`, `setSessionMode`, `setSessionModel`, `setSessionThoughtLevel`, `setSessionConfigOption`, `getSessionConfigOptions`, and `getSessionModes`.
- `Session` helpers are `prompt(...)`, `send(...)`, and `onEvent(...)`. - `Session` helpers are `prompt(...)`, `send(...)`, `onEvent(...)`, `setMode(...)`, `setModel(...)`, `setThoughtLevel(...)`, `setConfigOption(...)`, `getConfigOptions()`, and `getModes()`.
- Cleanup is `sdk.dispose()`. - Cleanup is `sdk.dispose()`.
### Docs Source Of Truth ### Docs Source Of Truth

4
docs/agent-sessions.mdx
View file

@ -91,7 +91,7 @@ Set the model, mode, or thought level on a session at creation time or after:
const session = await sdk.createSession({ const session = await sdk.createSession({
agent: "codex", agent: "codex",
model: "gpt-5.3-codex", model: "gpt-5.3-codex",
mode: "plan", mode: "auto",
thoughtLevel: "high", thoughtLevel: "high",
}); });
``` ```
@ -99,7 +99,7 @@ const session = await sdk.createSession({
```ts ```ts
// After creation // After creation
await session.setModel("gpt-5.2-codex"); await session.setModel("gpt-5.2-codex");
await session.setMode("build"); await session.setMode("full-access");
await session.setThoughtLevel("medium"); await session.setThoughtLevel("medium");
``` ```

2
docs/sdk-overview.mdx
View file

@ -111,7 +111,7 @@ const session = await sdk.createSession({
}); });
await session.setModel("gpt-5.2-codex"); await session.setModel("gpt-5.2-codex");
await session.setMode("plan"); await session.setMode("auto");
const options = await session.getConfigOptions(); const options = await session.getConfigOptions();
const modes = await session.getModes(); const modes = await session.getModes();