diff --git a/README.md b/README.md index a19c7c4..889fe49 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,26 @@ # Agent Studio Mini -Agent Studio Mini 是一个用于内部培训的、可运行的最小 AI Agent Harness。它用 Pi Coding Agent SDK 驱动 Agent Loop,以 Fastify + SSE 暴露受控协议,用 assistant-ui 展示聊天、Tool、审批、图片附件与完整事件时间线。 +> 一个面向内部培训、可直接运行的最小 AI Agent Harness。 -当前仓库未附产品截图;启动后,`http://127.0.0.1:5173` 即是桌面三栏和移动端 Tabs 的真实演示界面。 +Agent Studio Mini 使用 Pi Coding Agent SDK 驱动 Agent Loop,通过 Fastify + SSE 暴露受控协议,并以 assistant-ui 呈现聊天、Tool 调用、人工审批、图片附件和完整事件时间线。 + +
+
+
+
+
桌面端演示界面 · 点击图片查看原图
+ +## 核心能力 + +- **完整 Agent Loop**:流式对话、Tool 生命周期、取消、超时与错误处理。 +- **Human-in-the-loop**:敏感 Tool 执行前审批,支持批准、拒绝和超时。 +- **Skills 渐进加载**:按需发现并读取 Skill,避免一次性注入全部上下文。 +- **多模态附件**:支持 JPEG、PNG、WebP 上传、清洗、预览与模型能力校验。 +- **可观测事件流**:SSE 重放、断线恢复、事件去重与完整 Timeline。 +- **安全边界示例**:Tool allowlist、路径守卫、凭证加密、SSRF 防护与日志脱敏。 + +**文档导航:** [架构](#架构) · [快速开始](#快速开始) · [模型配置](#模型配置) · [Skills](#skills-与-progressive-disclosure) · [Tools 与审批](#tools-与-approval) · [图片链路](#图片多模态链路) · [安全边界](#安全边界) · [生产化路线](#已知限制与生产化) ## 架构 @@ -51,17 +69,25 @@ workspace/sessions 运行时临时 Session(被 gitignore) docs 架构、映射、安全、课堂脚本与路线图 ``` -## 环境与启动 +## 快速开始 -Pi 0.84.3 的实际 package engine 要求 Node.js `>=22.19.0`,因此本仓库采用该版本,而不是需求草案中的 Node 20 下限。需要 pnpm 11。 +### 环境要求 + +- Node.js `>=22.19.0`(Pi 0.84.3 的 package engine 要求) +- pnpm 11 + +### 本地运行 ```bash cp .env.example .env +# 至少填写 AGENT_PROVIDER 和 AGENT_MODEL;API Key 也可启动后在 Settings 中提交 pnpm install pnpm dev ``` -Server 默认监听 `127.0.0.1:3001`,Vite Web 默认监听 `127.0.0.1:5173` 并代理 `/api` 与 `/health`。打开 `http://127.0.0.1:5173`。根命令还包括: +Server 默认监听 `127.0.0.1:3001`,Vite Web 默认监听 `127.0.0.1:5173`,并代理 `/api` 与 `/health`。启动后访问 **http://127.0.0.1:5173**。 + +常用质量检查命令: ```bash pnpm lint diff --git a/assets/demo.png b/assets/demo.png new file mode 100644 index 0000000..5195699 Binary files /dev/null and b/assets/demo.png differ