chore: add bug report section and simplify description

This commit is contained in:
Nathan Flurry 2026-01-29 06:02:33 -08:00
parent 238d158841
commit b89b19447e

View file

@ -1,12 +1,29 @@
---
name: "sandbox-agent"
description: "Deploy, configure, and integrate Sandbox Agent - a universal API for orchestrating AI coding agents (Claude Code, Codex, OpenCode, Amp) in sandboxed environments. Use when: (1) Setting up sandbox-agent server locally or in cloud sandboxes (E2B, Daytona, Docker), (2) Creating and managing agent sessions via SDK or API, (3) Streaming agent events and handling human-in-the-loop interactions, (4) Building chat UIs for coding agents, (5) Understanding the universal schema for agent responses."
description: "Deploy, configure, and integrate Sandbox Agent - a universal API for orchestrating AI coding agents (Claude Code, Codex, OpenCode, Amp) in sandboxed environments. Use when setting up sandbox-agent server locally or in cloud sandboxes (E2B, Daytona, Docker), creating and managing agent sessions via SDK or API, streaming agent events and handling human-in-the-loop interactions, building chat UIs for coding agents, or understanding the universal schema for agent responses."
---
# Sandbox Agent
Sandbox Agent provides a universal API for orchestrating AI coding agents in sandboxed environments.
## What To Do If You Get Stuck
If something is not working as intended or you are stuck, prompt the user to file an issue on [GitHub](https://github.com/rivet-dev/sandbox-agent/issues) to report an issue and get help.
Provide the user with a pre-generated report with:
- Symptoms
- If this is happening in local dev, deployed, or both
- The error you're seeing
- Relevant source code related to this
- What you've tried to solve it
- Environment
- Sandbox Agent version
- SDK in use (TypeScript, Python, or HTTP)
- Agent in use (Claude Code, Codex, OpenCode, Amp, Mock)
- Sandbox provider (E2B, Daytona, Docker, local)
## Quickstart
{{QUICKSTART}}