opc-agent 1.3.1 → 1.3.2

package/docs/zh/guide/templates.md

@@ -1,84 +1,84 @@
-# 模板
-
-OPC Agent 提供 12 个开箱即用的场景模板，覆盖常见的企业智能体需求。
-
-## 模板列表
-
-| 模板 | 说明 | 适用场景 |
-|------|------|---------|
-| `customer-service` | 客服智能体 | FAQ 自动回答 + 转人工 |
-| `sales-assistant` | 销售助手 | 产品问答 + 线索捕获 + 预约 |
-| `knowledge-base` | 知识库问答 | 基于文档的 RAG 语义检索 |
-| `code-reviewer` | 代码审查 | Bug 检测 + 代码风格检查 |
-| `hr-recruiter` | HR 招聘助手 | 简历筛选 + 面试安排 |
-| `project-manager` | 项目管理 | 任务跟踪 + 会议纪要 |
-| `content-writer` | 内容创作 | 博客写作 + 社媒运营 + SEO |
-| `legal-assistant` | 法务助手 | 合同审查 + 合规检查 |
-| `financial-advisor` | 财务顾问 | 预算管理 + 支出分析 |
-| `executive-assistant` | 行政助理 | 日程管理 + 邮件处理 |
-| `data-analyst` | 数据分析师 | SQL 查询 + 数据可视化 |
-| `teacher` | 教学助手 | 课程设计 + 出题 + 互动 |
-
-## 使用模板
-
-```bash
-# 创建时指定模板
-opc init my-agent --template customer-service
-
-# 或者用简写
-opc init my-agent -t sales-assistant
-```
-
-## 客服智能体详解
-
-```yaml
-# customer-service/oad.yaml
-apiVersion: opc/v1
-kind: Agent
-metadata:
-  name: customer-service
-  version: 1.0.0
-  description: "客服智能体：FAQ 查询 + 人工转接"
-spec:
-  provider:
-    default: deepseek
-  model: deepseek-chat
-  systemPrompt: |
-    你是一个友好、专业的客服助手。
-    帮助客户解答产品、订单、物流、退换货等问题。
-    回答要简洁、有帮助、有同理心。
-  skills:
-    - name: faq-lookup
-      description: "FAQ 知识库查询"
-    - name: human-handoff
-      description: "转接人工客服"
-  channels:
-    - type: web
-      port: 3000
-```
-
-## 自定义模板
-
-你可以基于现有模板修改，也可以从头创建：
-
-1. 编写 `oad.yaml` 定义智能体
-2. 继承 `BaseSkill` 实现自定义技能
-3. 将 `oad.yaml` + `README.md` 打包成一个目录
-
-```typescript
-import { BaseSkill } from 'opc-agent';
-import type { AgentContext, Message, SkillResult } from 'opc-agent';
-
-export class MySkill extends BaseSkill {
-  name = 'my-skill';
-  description = '我的自定义技能';
-
-  async execute(context: AgentContext, message: Message): Promise<SkillResult> {
-    // 你的技能逻辑
-    if (message.content.includes('关键词')) {
-      return this.match('这是我的回答', 0.9);
-    }
-    return this.noMatch();
-  }
-}
-```
+# 模板
+
+OPC Agent 提供 12 个开箱即用的场景模板，覆盖常见的企业智能体需求。
+
+## 模板列表
+
+| 模板 | 说明 | 适用场景 |
+|------|------|---------|
+| `customer-service` | 客服智能体 | FAQ 自动回答 + 转人工 |
+| `sales-assistant` | 销售助手 | 产品问答 + 线索捕获 + 预约 |
+| `knowledge-base` | 知识库问答 | 基于文档的 RAG 语义检索 |
+| `code-reviewer` | 代码审查 | Bug 检测 + 代码风格检查 |
+| `hr-recruiter` | HR 招聘助手 | 简历筛选 + 面试安排 |
+| `project-manager` | 项目管理 | 任务跟踪 + 会议纪要 |
+| `content-writer` | 内容创作 | 博客写作 + 社媒运营 + SEO |
+| `legal-assistant` | 法务助手 | 合同审查 + 合规检查 |
+| `financial-advisor` | 财务顾问 | 预算管理 + 支出分析 |
+| `executive-assistant` | 行政助理 | 日程管理 + 邮件处理 |
+| `data-analyst` | 数据分析师 | SQL 查询 + 数据可视化 |
+| `teacher` | 教学助手 | 课程设计 + 出题 + 互动 |
+
+## 使用模板
+
+```bash
+# 创建时指定模板
+opc init my-agent --template customer-service
+
+# 或者用简写
+opc init my-agent -t sales-assistant
+```
+
+## 客服智能体详解
+
+```yaml
+# customer-service/oad.yaml
+apiVersion: opc/v1
+kind: Agent
+metadata:
+  name: customer-service
+  version: 1.0.0
+  description: "客服智能体：FAQ 查询 + 人工转接"
+spec:
+  provider:
+    default: deepseek
+  model: deepseek-chat
+  systemPrompt: |
+    你是一个友好、专业的客服助手。
+    帮助客户解答产品、订单、物流、退换货等问题。
+    回答要简洁、有帮助、有同理心。
+  skills:
+    - name: faq-lookup
+      description: "FAQ 知识库查询"
+    - name: human-handoff
+      description: "转接人工客服"
+  channels:
+    - type: web
+      port: 3000
+```
+
+## 自定义模板
+
+你可以基于现有模板修改，也可以从头创建：
+
+1. 编写 `oad.yaml` 定义智能体
+2. 继承 `BaseSkill` 实现自定义技能
+3. 将 `oad.yaml` + `README.md` 打包成一个目录
+
+```typescript
+import { BaseSkill } from 'opc-agent';
+import type { AgentContext, Message, SkillResult } from 'opc-agent';
+
+export class MySkill extends BaseSkill {
+  name = 'my-skill';
+  description = '我的自定义技能';
+
+  async execute(context: AgentContext, message: Message): Promise<SkillResult> {
+    // 你的技能逻辑
+    if (message.content.includes('关键词')) {
+      return this.match('这是我的回答', 0.9);
+    }
+    return this.noMatch();
+  }
+}
+```

package/docs/zh/guide/testing.md

@@ -1,88 +1,88 @@
-# 测试
-
-## 概览
-
-OPC Agent 内置了测试框架。你可以在 `oad.yaml` 或单独的 `tests.yaml` 中定义测试用例，用 `opc test` 一键运行。
-
-## 在 OAD 中定义测试
-
-```yaml
-spec:
-  testing:
-    cases:
-      - name: 问候测试
-        input: "你好！"
-        expect:
-          contains: ["你好", "帮"]
-          maxLatencyMs: 5000
-
-      - name: 产品咨询
-        input: "你们怎么收费？"
-        expect:
-          contains: ["价格", "套餐"]
-          notContains: ["error"]
-
-      - name: 空输入
-        input: ""
-        expect:
-          maxLatencyMs: 2000
-```
-
-## 独立测试文件
-
-在 `oad.yaml` 同目录创建 `tests.yaml`：
-
-```yaml
-cases:
-  - name: 冒烟测试
-    input: "你好"
-    expect:
-      maxLatencyMs: 10000
-
-  - name: FAQ 验证
-    input: "退货政策是什么？"
-    expect:
-      contains: ["退货", "退款"]
-```
-
-## 运行测试
-
-```bash
-# 运行测试
-opc test
-
-# JSON 格式输出
-opc test --json
-
-# 指定 OAD 文件
-opc test -f my-agent.yaml
-
-# 监听模式（改了代码自动重跑）
-opc test --watch
-```
-
-## 测试报告
-
-```
-═══════════════════════════════════════════
-  OPC Agent 测试报告
-═══════════════════════════════════════════
-
-  ✔ [通过] 问候测试 (245ms)
-  ✔ [通过] 产品咨询 (312ms)
-  ✘ [失败] 空输入 (5120ms)
-      → 延迟 5120ms 超过上限 2000ms
-
-───────────────────────────────────────────
-  总计: 3  通过: 2  失败: 1  耗时: 5677ms
-───────────────────────────────────────────
-```
-
-## 断言类型
-
-| 断言 | 说明 |
-|------|------|
-| `contains` | 回复必须包含这些字符串（不区分大小写） |
-| `notContains` | 回复不能包含这些字符串 |
-| `toolCalled` | 指定的工具必须被调用 |
-| `maxLatencyMs` | 响应必须在指定时间内完成 |
+# 测试
+
+## 概览
+
+OPC Agent 内置了测试框架。你可以在 `oad.yaml` 或单独的 `tests.yaml` 中定义测试用例，用 `opc test` 一键运行。
+
+## 在 OAD 中定义测试
+
+```yaml
+spec:
+  testing:
+    cases:
+      - name: 问候测试
+        input: "你好！"
+        expect:
+          contains: ["你好", "帮"]
+          maxLatencyMs: 5000
+
+      - name: 产品咨询
+        input: "你们怎么收费？"
+        expect:
+          contains: ["价格", "套餐"]
+          notContains: ["error"]
+
+      - name: 空输入
+        input: ""
+        expect:
+          maxLatencyMs: 2000
+```
+
+## 独立测试文件
+
+在 `oad.yaml` 同目录创建 `tests.yaml`：
+
+```yaml
+cases:
+  - name: 冒烟测试
+    input: "你好"
+    expect:
+      maxLatencyMs: 10000
+
+  - name: FAQ 验证
+    input: "退货政策是什么？"
+    expect:
+      contains: ["退货", "退款"]
+```
+
+## 运行测试
+
+```bash
+# 运行测试
+opc test
+
+# JSON 格式输出
+opc test --json
+
+# 指定 OAD 文件
+opc test -f my-agent.yaml
+
+# 监听模式（改了代码自动重跑）
+opc test --watch
+```
+
+## 测试报告
+
+```
+═══════════════════════════════════════════
+  OPC Agent 测试报告
+═══════════════════════════════════════════
+
+  ✔ [通过] 问候测试 (245ms)
+  ✔ [通过] 产品咨询 (312ms)
+  ✘ [失败] 空输入 (5120ms)
+      → 延迟 5120ms 超过上限 2000ms
+
+───────────────────────────────────────────
+  总计: 3  通过: 2  失败: 1  耗时: 5677ms
+───────────────────────────────────────────
+```
+
+## 断言类型
+
+| 断言 | 说明 |
+|------|------|
+| `contains` | 回复必须包含这些字符串（不区分大小写） |
+| `notContains` | 回复不能包含这些字符串 |
+| `toolCalled` | 指定的工具必须被调用 |
+| `maxLatencyMs` | 响应必须在指定时间内完成 |

package/docs/zh/index.md

@@ -1,27 +1,27 @@
----
-layout: home
-hero:
-  name: OPC Agent
-  text: 开放智能体框架
-  tagline: 构建、测试、运行企业级 AI 智能体
-  actions:
-    - theme: brand
-      text: 快速开始
-      link: /zh/guide/getting-started
-    - theme: alt
-      text: GitHub
-      link: https://github.com/Deepleaper/opc-agent
-features:
-  - title: ⚡ 30 秒上手
-    details: 两条命令创建智能体，开箱即用，支持 12 个场景模板
-  - title: 📋 OAD 声明式定义
-    details: 用 YAML 文件定义智能体的一切：模型、技能、渠道、安全策略
-  - title: 📡 多渠道部署
-    details: Web、Telegram、Slack、微信公众号、飞书、WebSocket，一套代码到处运行
-  - title: 🧪 内置测试框架
-    details: 在 OAD 文件中定义测试用例，opc test 一键验证智能体行为
-  - title: 🔌 多模型支持
-    details: DeepSeek、通义千问、OpenAI、Anthropic、Ollama，不绑定任何一家
-  - title: 🧠 知识库 RAG
-    details: 添加文档自动构建知识库，智能体回答时语义检索增强
----
+---
+layout: home
+hero:
+  name: OPC Agent
+  text: 开放智能体框架
+  tagline: 构建、测试、运行企业级 AI 智能体
+  actions:
+    - theme: brand
+      text: 快速开始
+      link: /zh/guide/getting-started
+    - theme: alt
+      text: GitHub
+      link: https://github.com/Deepleaper/opc-agent
+features:
+  - title: ⚡ 30 秒上手
+    details: 两条命令创建智能体，开箱即用，支持 12 个场景模板
+  - title: 📋 OAD 声明式定义
+    details: 用 YAML 文件定义智能体的一切：模型、技能、渠道、安全策略
+  - title: 📡 多渠道部署
+    details: Web、Telegram、Slack、微信公众号、飞书、WebSocket，一套代码到处运行
+  - title: 🧪 内置测试框架
+    details: 在 OAD 文件中定义测试用例，opc test 一键验证智能体行为
+  - title: 🔌 多模型支持
+    details: DeepSeek、通义千问、OpenAI、Anthropic、Ollama，不绑定任何一家
+  - title: 🧠 知识库 RAG
+    details: 添加文档自动构建知识库，智能体回答时语义检索增强
+---

package/examples/customer-service-demo/README.md

@@ -1,90 +1,90 @@
-# ShopBot — Customer Service Demo
-
-A complete e-commerce customer service agent built with OPC Agent, deployable to OpenClaw.
-
-## What's Inside
-
-- `oad.yaml` — Full agent definition with product FAQ, order tracking, complaint handling
-- Rich system prompt with personality, escalation rules, and response templates
-- Telegram + Web channel configuration
-
-## Quick Start
-
-### 1. Install OPC Agent
-
-```bash
-npm install -g opc-agent
-```
-
-### 2. Validate the Agent
-
-```bash
-cd examples/customer-service-demo
-opc info
-opc build
-```
-
-### 3. Deploy to OpenClaw
-
-**Option A: Generate workspace files**
-```bash
-opc deploy --target openclaw --output ./shopbot-workspace
-```
-
-This creates a complete OpenClaw agent workspace with:
-- `IDENTITY.md` — Agent identity
-- `SOUL.md` — System prompt and model config
-- `AGENTS.md` — Skills, memory, and trust config
-- `USER.md` — User preferences template
-- `MEMORY.md` — Persistent memory template
-
-**Option B: Deploy and auto-register**
-```bash
-opc deploy --target openclaw --install
-```
-
-This generates the workspace AND registers the agent in `~/.openclaw/openclaw.json`.
-
-### 4. Restart OpenClaw
-
-```bash
-openclaw gateway restart
-```
-
-### 5. Test in Telegram
-
-Send a message to your OpenClaw Telegram bot. ShopBot will respond!
-
-Try these:
-- "What headphones do you sell?"
-- "Track my order TS-123456"
-- "I want to return my laptop stand"
-- "This is unacceptable, I want to speak to a manager"
-
-## Architecture
-
-```
-OPC Agent (Development)          OpenClaw (Runtime)
-┌─────────────────────┐         ┌──────────────────────┐
-│  oad.yaml           │         │  IDENTITY.md         │
-│  (agent definition) │──deploy─│  SOUL.md             │
-│                     │         │  AGENTS.md           │
-│  opc build/test     │         │  USER.md             │
-│  opc deploy         │         │  MEMORY.md           │
-└─────────────────────┘         │                      │
-                                │  ← Telegram/Web →    │
-                                └──────────────────────┘
-```
-
-OPC Agent is the **development framework**. OpenClaw is the **runtime**.
-
-## Customization
-
-Edit `oad.yaml` to:
-- Change the product catalog
-- Adjust escalation rules
-- Add new skills
-- Switch LLM provider/model
-- Modify the system prompt personality
-
-Then re-deploy: `opc deploy --target openclaw --install`
+# ShopBot — Customer Service Demo
+
+A complete e-commerce customer service agent built with OPC Agent, deployable to OpenClaw.
+
+## What's Inside
+
+- `oad.yaml` — Full agent definition with product FAQ, order tracking, complaint handling
+- Rich system prompt with personality, escalation rules, and response templates
+- Telegram + Web channel configuration
+
+## Quick Start
+
+### 1. Install OPC Agent
+
+```bash
+npm install -g opc-agent
+```
+
+### 2. Validate the Agent
+
+```bash
+cd examples/customer-service-demo
+opc info
+opc build
+```
+
+### 3. Deploy to OpenClaw
+
+**Option A: Generate workspace files**
+```bash
+opc deploy --target openclaw --output ./shopbot-workspace
+```
+
+This creates a complete OpenClaw agent workspace with:
+- `IDENTITY.md` — Agent identity
+- `SOUL.md` — System prompt and model config
+- `AGENTS.md` — Skills, memory, and trust config
+- `USER.md` — User preferences template
+- `MEMORY.md` — Persistent memory template
+
+**Option B: Deploy and auto-register**
+```bash
+opc deploy --target openclaw --install
+```
+
+This generates the workspace AND registers the agent in `~/.openclaw/openclaw.json`.
+
+### 4. Restart OpenClaw
+
+```bash
+openclaw gateway restart
+```
+
+### 5. Test in Telegram
+
+Send a message to your OpenClaw Telegram bot. ShopBot will respond!
+
+Try these:
+- "What headphones do you sell?"
+- "Track my order TS-123456"
+- "I want to return my laptop stand"
+- "This is unacceptable, I want to speak to a manager"
+
+## Architecture
+
+```
+OPC Agent (Development)          OpenClaw (Runtime)
+┌─────────────────────┐         ┌──────────────────────┐
+│  oad.yaml           │         │  IDENTITY.md         │
+│  (agent definition) │──deploy─│  SOUL.md             │
+│                     │         │  AGENTS.md           │
+│  opc build/test     │         │  USER.md             │
+│  opc deploy         │         │  MEMORY.md           │
+└─────────────────────┘         │                      │
+                                │  ← Telegram/Web →    │
+                                └──────────────────────┘
+```
+
+OPC Agent is the **development framework**. OpenClaw is the **runtime**.
+
+## Customization
+
+Edit `oad.yaml` to:
+- Change the product catalog
+- Adjust escalation rules
+- Add new skills
+- Switch LLM provider/model
+- Modify the system prompt personality
+
+Then re-deploy: `opc deploy --target openclaw --install`