wehub-resource-sync
bcbd1bdb22
Integ / changes (push) Has been skipped
Pre-commit / pre-commit (push) Failing after 1s
CLI exit codes / changes (push) Has been skipped
Test (Install) / changes (push) Has been skipped
Test (Python) / changes (push) Has been skipped
Test (TypeScript) / changes (push) Has been skipped
CLI exit codes / cli-gate (push) Has been cancelled
Test (Install) / test-install-gate (push) Has been cancelled
Integ / integ-gate (push) Has been cancelled
Test (Python) / test-python-gate (push) Has been cancelled
Test (TypeScript) / test-typescript-gate (push) Has been cancelled
Test (Install) / python-minimal (3.12) (push) Has been cancelled
Test (Install) / python-minimal (3.11) (push) Has been cancelled
Test (Install) / python-extra (agno, mirage.agents.agno) (push) Has been cancelled
Test (Install) / python-extra (chroma, mirage.resource.chroma) (push) Has been cancelled
Test (Install) / python-extra (pdf, mirage.core.filetype.pdf) (push) Has been cancelled
Integ / integ (push) Has been cancelled
Integ / integ-database (push) Has been cancelled
Integ / integ-database-ts (push) Has been cancelled
Integ / integ-data (push) Has been cancelled
Integ / integ-ssh (push) Has been cancelled
Integ / integ-ssh-ts (push) Has been cancelled
Test (Python) / audit (push) Has been cancelled
Test (TypeScript) / test (push) Has been cancelled
Test (TypeScript) / python-fs-shim (push) Has been cancelled
CLI exit codes / Python CLI (push) Has been cancelled
CLI exit codes / TypeScript CLI (push) Has been cancelled
CLI exit codes / Cross-language snapshot interop (push) Has been cancelled
Test (Python) / test (push) Has been cancelled
Test (Python) / import-isolation (deepagents, openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Python) / import-isolation (deepagents, pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Integ / integ-ts (push) Has been cancelled
Integ / integ-fuse (push) Has been cancelled
Test (Install) / python-extra (databricks, mirage.resource.databricks_volume) (push) Has been cancelled
Test (Install) / python-extra (deepagents, mirage.agents.langchain) (push) Has been cancelled
Test (Install) / python-extra (email, mirage.resource.email) (push) Has been cancelled
Test (Install) / python-extra (fuse, mirage.fuse.mount) (push) Has been cancelled
Test (Install) / python-extra (hdf5, mirage.core.filetype.hdf5) (push) Has been cancelled
Test (Install) / python-extra (hf, mirage.resource.hf_buckets) (push) Has been cancelled
Test (Install) / python-extra (lancedb, mirage.resource.lancedb) (push) Has been cancelled
Test (Install) / python-extra (langfuse, mirage.resource.langfuse) (push) Has been cancelled
Test (Install) / python-extra (mongodb, mirage.resource.mongodb) (push) Has been cancelled
Test (Install) / python-extra (nextcloud, mirage.resource.nextcloud) (push) Has been cancelled
Test (Install) / python-extra (openai, mirage.agents.openai_agents) (push) Has been cancelled
Test (Install) / python-extra (openhands, mirage.agents.openhands, 3.12) (push) Has been cancelled
Test (Install) / python-extra (parquet, mirage.core.filetype.parquet) (push) Has been cancelled
Test (Install) / python-extra (postgres, mirage.resource.postgres) (push) Has been cancelled
Test (Install) / python-extra (pydantic-ai, mirage.agents.pydantic_ai) (push) Has been cancelled
Test (Install) / python-extra (qdrant, mirage.resource.qdrant) (push) Has been cancelled
Test (Install) / python-extra (redis, mirage.resource.redis) (push) Has been cancelled
Test (Install) / python-extra (s3, mirage.resource.s3) (push) Has been cancelled
Test (Install) / python-extra (ssh, mirage.resource.ssh) (push) Has been cancelled
Test (Install) / ts-minimal (push) Has been cancelled
71 lines
2.4 KiB
Plaintext
71 lines
2.4 KiB
Plaintext
---
|
|
title: OpenAI Agents SDK
|
|
description: Run openai-agents against a Mirage workspace using MirageShellExecutor, MirageEditor, and MirageSandboxClient.
|
|
icon: /images/openai-logo.svg
|
|
---
|
|
|
|
The OpenAI Agents Python SDK ([openai-agents](https://github.com/openai/openai-agents-python)) ships built-in `ShellTool` and `ApplyPatchTool` primitives, plus the newer `SandboxAgent`. Mirage provides drop-in replacements that route every shell command, patch, and sandbox call through your `Workspace` instead of the host.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
uv add 'mirage-ai[openai]'
|
|
```
|
|
|
|
This pulls in `openai>=2.30` and `openai-agents>=0.14.7`.
|
|
|
|
## Tools (`ShellTool` + `ApplyPatchTool`)
|
|
|
|
```python
|
|
from agents import Agent, ApplyPatchTool, Runner, ShellTool
|
|
|
|
from mirage import MountMode, Workspace
|
|
from mirage.agents.openai_agents import (
|
|
MirageEditor,
|
|
MirageShellExecutor,
|
|
build_system_prompt,
|
|
)
|
|
from mirage.resource.ram import RAMResource
|
|
|
|
ws = Workspace({"/": RAMResource()}, mode=MountMode.WRITE)
|
|
|
|
agent = Agent(
|
|
name="Mirage RAM Agent",
|
|
model="gpt-5.5-mini",
|
|
instructions=build_system_prompt(
|
|
mount_info={"/": "In-memory filesystem (read/write)"},
|
|
),
|
|
tools=[
|
|
ShellTool(executor=MirageShellExecutor(ws)),
|
|
ApplyPatchTool(editor=MirageEditor(ws)),
|
|
],
|
|
)
|
|
```
|
|
|
|
## Sandbox Agent
|
|
|
|
For the new `SandboxAgent` API, use `MirageSandboxClient`:
|
|
|
|
```python
|
|
from agents.sandbox import SandboxAgent
|
|
from mirage.agents.openai_agents import MirageSandboxClient
|
|
|
|
client = MirageSandboxClient(ws)
|
|
agent = SandboxAgent(name="...", model="gpt-5.5", instructions=ws.file_prompt)
|
|
```
|
|
|
|
## Exports
|
|
|
|
| Symbol | Purpose |
|
|
| --- | --- |
|
|
| `MirageShellExecutor` | Drop-in `ShellTool` executor, runs inside `Workspace.execute()`. |
|
|
| `MirageEditor` | Drop-in `ApplyPatchTool` editor, patches go through Mirage FS ops. |
|
|
| `MirageSandboxClient` | Adapter for `agents.sandbox.SandboxAgent`. |
|
|
| `MirageSandboxSession` | Per-conversation session bound to a workspace. |
|
|
| `build_system_prompt` | Generates a system prompt that describes mounted paths to the model. |
|
|
|
|
## Examples
|
|
|
|
- [`examples/python/agents/openai_agents/ram_agent.py`](https://github.com/strukto-ai/mirage/blob/main/examples/python/agents/openai_agents/ram_agent.py), RAM-only sandbox.
|
|
- [`examples/python/agents/openai_agents/sandbox_agent.py`](https://github.com/strukto-ai/mirage/blob/main/examples/python/agents/openai_agents/sandbox_agent.py), `SandboxAgent` over RAM + S3 + Slack.
|