Instructions

SDK Modes

There are two ways to work with the SDKs:

Embedded: Spawns the sandbox-agent server as a subprocess on a unique port and communicates with it locally. Useful for local development or when running the SDK and agent in the same environment.
Server: Connects to a remotely running sandbox-agent server. The server is typically running inside a sandbox (e.g., Docker, E2B, Daytona, Vercel Sandboxes) and the SDK connects to it over HTTP.

Agent Schemas

Agent schemas (Claude Code, Codex, OpenCode, Amp) are available for reference in resources/agent-schemas/artifacts/json-schema/.

Extraction methods:

Claude: Uses claude --output-format json --json-schema CLI command
Codex: Uses codex app-server generate-json-schema CLI command
OpenCode: Fetches from GitHub OpenAPI spec
Amp: Scrapes from https://ampcode.com/manual/appendix?preview#message-schema

All extractors have fallback schemas for when CLI/URL is unavailable.

Research on how different agents operate (CLI flags, streaming formats, HITL patterns, etc.) is in research/agents/. When adding or making changes to agent docs, follow the same structure as existing files.

Universal schema guidance:

The universal schema should cover the full feature set of all agents.
Conversions must be best-effort overlap without being lossy; preserve raw payloads when needed.

Spec Tracking

Update todo.md as work progresses; add new tasks as they arise.
Keep CLI subcommands in sync with every HTTP endpoint.
Update CLAUDE.md to keep CLI endpoints in sync with HTTP API changes.
When changing the HTTP API, update the TypeScript SDK and CLI together.
Do not make breaking changes to API endpoints.
When changing API routes, ensure the HTTP/SSE test suite has full coverage of every route.
When agent schema changes, ensure API tests cover the new schema and event shapes end-to-end.
Update docs/conversion.md whenever agent-native schema terms, synthetic events, identifier mappings, or conversion logic change.
Never use synthetic data or mocked responses in tests.
Never manually write agent types; always use generated types in resources/agent-schemas/. If types are broken, fix the generated types.
The universal schema must provide consistent behavior across providers; avoid requiring frontend/client logic to special-case agents.
When parsing agent data, if something is unexpected or does not match the schema, bail out and surface the error rather than trying to continue with partial parsing.
When defining the universal schema, choose the option most compatible with native agent APIs, and add synthetics to fill gaps for other agents.
Use docs/glossary.md as the source of truth for universal schema terminology and keep it updated alongside schema changes.
On parse failures, emit an agent.unparsed event (source=daemon, synthetic=true) and treat it as a test failure. Preserve raw payloads when include_raw=true.
Track subagent support in docs/conversion.md. For now, normalize subagent activity into normal message/tool flow, but revisit explicit subagent modeling later.

CLI ⇄ HTTP endpoint map (keep in sync)

sandbox-agent agents list ↔ GET /v1/agents
sandbox-agent agents install ↔ POST /v1/agents/{agent}/install
sandbox-agent agents modes ↔ GET /v1/agents/{agent}/modes
sandbox-agent sessions list ↔ GET /v1/sessions
sandbox-agent sessions create ↔ POST /v1/sessions/{sessionId}
sandbox-agent sessions send-message ↔ POST /v1/sessions/{sessionId}/messages
sandbox-agent sessions events / get-messages ↔ GET /v1/sessions/{sessionId}/events
sandbox-agent sessions events-sse ↔ GET /v1/sessions/{sessionId}/events/sse
sandbox-agent sessions reply-question ↔ POST /v1/sessions/{sessionId}/questions/{questionId}/reply
sandbox-agent sessions reject-question ↔ POST /v1/sessions/{sessionId}/questions/{questionId}/reject
sandbox-agent sessions reply-permission ↔ POST /v1/sessions/{sessionId}/permissions/{permissionId}/reply

Default port references (update when CLI default changes)

frontend/packages/inspector/src/App.tsx
README.md
docs/cli.mdx
docs/frontend.mdx
docs/index.mdx
docs/quickstart.mdx
docs/typescript-sdk.mdx
docs/deployments/cloudflare-sandboxes.mdx
docs/deployments/daytona.mdx
docs/deployments/docker.mdx
docs/deployments/e2b.mdx
docs/deployments/vercel-sandboxes.mdx

Git Commits

Do not include any co-authors in commit messages (no Co-Authored-By lines)
Use conventional commits style (e.g., feat:, fix:, docs:, chore:, refactor:)
Keep commit messages to a single line

4.7 KiB Raw Blame History