Repository navigation
docs(providers): add a guide to writing a sandbox provider - #284
Merged
Merged
Conversation
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
earakely-scale
approved these changes
Oct 21, 2026
… 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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 currentmain: nothing onSandboxProvideris abstract,terminate_sandboxandprepare_imageexist, andboxd,tensorlake,vercelandtenkiare the reference backends besidee2b. RootAGENTS.mdlinks 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.

Confidence 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.Reviews (3) · Last reviewed commit: "address review round 2: correct the buil..." · Reviewed by Greptile