Skip to content

docs(providers): add a guide to writing a sandbox provider - #284

Merged
cikowski merged 5 commits into
mainfrom
cikowski/sandbox-providers-agents-md
Oct 21, 2026
Merged

cikowski merged 5 commits into
mainfrom
cikowski/sandbox-providers-agents-md

Conversation

@cikowski

@cikowski cikowski commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

Adds src/agent_env/providers/sandbox_providers/AGENTS.md, a guide for coding agents and contributors on writing a sandbox provider, next to the code it covers (same layout as #279 for A2A agents).

It covers the provider and sandbox contracts, the declarations (SANDBOX_ACCEPTS, CONTAINER_ACCEPTS, ...), lifecycle, network policy hooks, registration (entry point or built-in), tests and a checklist. Written against current main: nothing on SandboxProvider is abstract, terminate_sandbox and prepare_image exist, and boxd, tensorlake, vercel and tenki are the reference backends beside e2b. Root AGENTS.md links to both guides.

Docs only; no code, no website content changed.

Co-Authored-By: Claude Sonnet 5.5 noreply@anthropic.com

🤖 Generated with Claude Code

Rollout

Docs only, no code path changes. Nothing to deploy, no order, no migration. Revert: revert the commits; nothing depends on the file. After merge: the website docs are unchanged, so a maintainer decides whether the sandbox provider page should mirror it.

Validation

Head 30713b4. Observed: every class, method, class variable and helper the guide names was checked by reading and grepping current main (sandbox_provider.py, sandbox.py, boxd/provider.py, tst/util/capabilities.py); the two Greptile findings were checked the same way and fixed. Observed: CI green (unit, integration-local, integration-local-slow, integration-local-gateway, clean-install, plugin-api, ui). Not run: a new provider built by following the guide end to end (agent-env plugin check, agent-env run hello --sandbox <name>); the guide's workflow steps are unexercised.

RetriggerView in GreptileConfidence Score: 5/5

This documentation-only PR appears safe to merge.

Summary

Adds a sandbox provider guide beside the provider code and links it from the root AGENTS.md.

  • Contributors can follow a guide to build sandbox providers.

Reviews (3) · Last reviewed commit: "address review round 2: correct the buil..." · Reviewed by Greptile

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@cikowski
cikowski requested a review from a team as a code owner October 21, 2026 18:59
Comment thread src/agent_env/providers/sandbox_providers/AGENTS.md Outdated
Comment thread src/agent_env/providers/sandbox_providers/AGENTS.md Outdated
cikowski and others added 4 commits October 21, 2026 12:10
… a new provider needs

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
… tests that enumerate built-ins, rewrap

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…reate_sandbox claims

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@cikowski
cikowski merged commit 42136c3 into main Oct 21, 2026
14 of 15 checks passed
@cikowski
cikowski deleted the cikowski/sandbox-providers-agents-md branch October 21, 2026 21:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants