logo
0
0
WeChat Login
docs: 优化 README 环境要求说明,明确正式集成不限技术栈

AgentOS 试用指引

AgentOS 是 WorkBuddy & CodeBuddy 的核心 Agentic 能力 + 企业级云端沙箱运行时环境,为第三方应用提供通过 API 创建和管理 AI Agent 沙箱的能力。本仓库提供开箱即用的试用脚本和文档,帮助企业客户在 30 分钟内跑通完整流程。

核心能力

能力说明
沙箱创建与管理通过 Runtime API 创建、查询、删除沙箱
Agent 对话通过 ACP 协议与沙箱内 AI Agent 实时交互(SSE 流式输出)
配置注入 (Manifest)创建沙箱时注入 rules、skills、MCP、secrets 等配置
文件操作通过 envd API 向沙箱读写文件

快速开始

1. 环境要求

  • 本 Demo:Python 3.8+
  • 网络:可访问 https://www.codebuddy.cn(需支持 HTTPS + SSE 长连接)

💡 本仓库的示例脚本使用 Python 编写,仅为快速验证。正式集成时可使用任意技术栈(Java、Go、Node.js 等),只需支持 HTTPS 请求SSE(Server-Sent Events)长连接JSON-RPC 2.0(ACP 协议)即可。

2. 安装依赖

pip install requests

3. 配置 API Key

CodeBuddy 密钥管理 获取 API Key,通过环境变量配置:

export E2E_API_KEY="ck_xxx.yyy"

4. 运行基础验证

# 8 步全流程 Demo(创建沙箱 → SSE → ACP 握手 → Agent 对话) python3 sandbox-full-flow-demo.py # 自定义 prompt python3 sandbox-full-flow-demo.py --prompt "帮我写一个 Hello World 程序"

5. 运行高级验证(Manifest 注入)

# 使用完整 Manifest 创建沙箱(含 rules/skills/MCP/secrets) python3 sandbox-manifest-demo.py --manifest-file fixtures/manifest-full.json # 验证 skills 是否注入成功 python3 sandbox-manifest-demo.py \ --manifest-file fixtures/manifest-full.json \ --prompt "查看 .codebuddy 目录下有哪些 skills 和 rules 配置文件"

文件结构

AgentOS-试用指引/ ├── README.md # 本文件 ├── AgentOS-测试验证方案.md # 完整测试验证方案文档 ├── api-reference.md # 试用相关接口参考(Runtime API / ACP / envd) ├── sandbox-full-flow-demo.py # 基础全流程 Demo(8 步) ├── sandbox-manifest-demo.py # Manifest 配置注入 Demo + 文件操作 └── fixtures/ └── manifest-full.json # 完整 AgentManifest 样本(27 个 skills)

验证场景

场景一:基础全流程(sandbox-full-flow-demo.py

以最简 Manifest(仅注入 CODEBUDDY_API_KEY)完成 8 步全流程:

  1. POST /v2/agentos/runtimes — 创建沙箱
  2. GET /v2/agentos/runtimes/{id} — 轮询等待就绪
  3. GET {acpUrl} (SSE) — 建立长连接,获取 Acp-Connection-Id
  4. POST {acpUrl} initialize — ACP 协议握手
  5. POST {acpUrl} session/new — 创建 Session
  6. POST {acpUrl} session/setMode — 设置权限模式
  7. POST {acpUrl} session/prompt — 发送用户消息
  8. 监听 SSE 事件流 — 接收 Agent 流式回复

关键顺序约束:Step 3 (SSE) → Step 4 (Initialize) → Step 5 (Session/New),三步顺序不可打乱。

场景二:Manifest 配置注入(sandbox-manifest-demo.py

验证通过 AgentManifest 注入完整配置的能力:

  • 注入 rules(行为规则)、skills(技能包)、MCP 配置、secrets(环境变量)
  • ${CODEBUDDY_API_KEY} 占位符自动替换
  • envd API 文件操作(写入 / 上传 / 读取)

常见问题

问题排查方向
session/new 拿不到 sessionId确认 SSE → Initialize → Session/New 顺序正确
SSE 连接失败确认 acpUrl 使用 https://,检查网络代理
沙箱一直 CREATING正常需 30~90s,最长 180s
HTTP 401检查 API Key 格式和有效性
Manifest 配置未生效确认 downloadUrl 可公网访问

文档参考

License

仅供内部试用评估。