Skip to content

Commit 7c4d69b

Browse files
committed
docs(readme): add MCP quick start section with sandbox_run_project
1 parent df1d8a0 commit 7c4d69b

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Sandchest is built around **forkable VMs**. An agent can set up an environment,
3333
- **TypeScript SDK** - `@sandchest/sdk` with a simple, modern API
3434
- **Python SDK** - `sandchest` on PyPI with full feature parity
3535
- **CLI** - `sandchest create`, `sandchest exec`, `sandchest fork`, `sandchest ssh`
36-
- **MCP server** - `@sandchest/mcp` for Claude Code and other AI tools
36+
- **MCP server** - `@sandchest/mcp` for Claude Code and other AI tools, including `sandbox_run_project` for one-shot repo commands
3737
- **GitHub Action** - provision sandboxes in CI/CD workflows
3838
- **Session replay** - every sandbox session is fully replayable (logs, actions, file changes) from the dashboard or as full context for agents in the CLI
3939

@@ -60,6 +60,19 @@ if (result.exitCode !== 0) {
6060
}
6161
```
6262

63+
## MCP quick start
64+
65+
For agent workflows, prefer the high-level MCP tool:
66+
67+
```text
68+
sandbox_run_project({
69+
command: "bun run lint",
70+
local_path: "/path/to/project"
71+
})
72+
```
73+
74+
That single tool call creates a sandbox, loads the project, installs dependencies, runs the command, and returns the replay URL.
75+
6376
## Project structure
6477

6578
```

0 commit comments

Comments
 (0)