opc-agent 1.2.0 → 1.2.1

package/docs/guide/getting-started.md

@@ -1,44 +1,44 @@
-# Getting Started
-
-## Installation
-
-```bash
-npm install -g opc-agent
-```
-
-## Create Your First Agent
-
-```bash
-# Initialize a new project
-opc init my-agent --template customer-service
-
-# Enter the project
-cd my-agent
-
-# Validate the OAD definition
-opc build
-
-# Run in sandbox mode
-opc test
-
-# Start the agent
-opc run
-```
-
-## Test the Agent
-
-```bash
-curl -X POST http://localhost:3000/chat \
-  -H "Content-Type: application/json" \
-  -d '{"message": "What are your business hours?"}'
-```
-
-## Project Structure
-
-```
-my-agent/
-├── oad.yaml       # Agent definition (OAD Schema v1)
-└── README.md
-```
-
-The `oad.yaml` file defines everything about your agent: its identity, skills, channels, and configuration.
+# Getting Started
+
+## Installation
+
+```bash
+npm install -g opc-agent
+```
+
+## Create Your First Agent
+
+```bash
+# Initialize a new project
+opc init my-agent --template customer-service
+
+# Enter the project
+cd my-agent
+
+# Validate the OAD definition
+opc build
+
+# Run in sandbox mode
+opc test
+
+# Start the agent
+opc run
+```
+
+## Test the Agent
+
+```bash
+curl -X POST http://localhost:3000/chat \
+  -H "Content-Type: application/json" \
+  -d '{"message": "What are your business hours?"}'
+```
+
+## Project Structure
+
+```
+my-agent/
+├── oad.yaml       # Agent definition (OAD Schema v1)
+└── README.md
+```
+
+The `oad.yaml` file defines everything about your agent: its identity, skills, channels, and configuration.

package/docs/guide/templates.md

@@ -1,28 +1,28 @@
-# Templates
-
-Templates are pre-built agent configurations for common use cases.
-
-## Customer Service
-
-A complete customer service agent with:
-- FAQ lookup skill
-- Human handoff when confidence is low
-- Web channel for HTTP integration
-
-```bash
-opc init my-service --template customer-service
-```
-
-## Creating Custom Templates
-
-Templates are OAD YAML files with optional skill implementations. To create your own:
-
-1. Define `oad.yaml` with your agent specification
-2. Implement custom skills extending `BaseSkill`
-3. Package as a directory with `oad.yaml` + `README.md`
-
-More templates coming soon:
-- Sales Assistant
-- Internal IT Help Desk
-- Data Analysis Agent
-- Content Moderation Agent
+# Templates
+
+Templates are pre-built agent configurations for common use cases.
+
+## Customer Service
+
+A complete customer service agent with:
+- FAQ lookup skill
+- Human handoff when confidence is low
+- Web channel for HTTP integration
+
+```bash
+opc init my-service --template customer-service
+```
+
+## Creating Custom Templates
+
+Templates are OAD YAML files with optional skill implementations. To create your own:
+
+1. Define `oad.yaml` with your agent specification
+2. Implement custom skills extending `BaseSkill`
+3. Package as a directory with `oad.yaml` + `README.md`
+
+More templates coming soon:
+- Sales Assistant
+- Internal IT Help Desk
+- Data Analysis Agent
+- Content Moderation Agent

package/docs/guide/testing.md

@@ -1,84 +1,84 @@
-# Testing
-
-## Overview
-
-OPC Agent includes a built-in testing framework. Define test cases in your `oad.yaml` or a separate `tests.yaml` file, then run them with `opc test`.
-
-## Defining Tests in OAD
-
-```yaml
-spec:
-  testing:
-    cases:
-      - name: greeting
-        input: "Hello!"
-        expect:
-          contains: ["hello", "help"]
-          maxLatencyMs: 5000
-      
-      - name: product-question
-        input: "What are your pricing plans?"
-        expect:
-          contains: ["pricing", "plan"]
-          notContains: ["error"]
-      
-      - name: edge-case-empty
-        input: ""
-        expect:
-          maxLatencyMs: 2000
-```
-
-## Separate Test File
-
-Create `tests.yaml` alongside your `oad.yaml`:
-
-```yaml
-cases:
-  - name: smoke-test
-    input: "Hi there"
-    expect:
-      maxLatencyMs: 10000
-  - name: faq-check
-    input: "What is your return policy?"
-    expect:
-      contains: ["return", "refund"]
-```
-
-## Running Tests
-
-```bash
-# Run tests
-opc test
-
-# JSON output
-opc test --json
-
-# Custom OAD file
-opc test -f my-agent.yaml
-```
-
-## Test Report
-
-```
-═══════════════════════════════════════════
-  OPC Agent Test Report
-═══════════════════════════════════════════
-
-  ✔ [PASS] greeting (245ms)
-  ✔ [PASS] product-question (312ms)
-  ✘ [FAIL] edge-case (5120ms)
-      → Latency 5120ms exceeded max 2000ms
-
-───────────────────────────────────────────
-  Total: 3  Passed: 2  Failed: 1  Duration: 5677ms
-───────────────────────────────────────────
-```
-
-## Assertions
-
-| Assertion | Description |
-|-----------|-------------|
-| `contains` | Response must include these strings (case-insensitive) |
-| `notContains` | Response must NOT include these strings |
-| `toolCalled` | Specified tools must have been invoked |
-| `maxLatencyMs` | Response must complete within this time |
+# Testing
+
+## Overview
+
+OPC Agent includes a built-in testing framework. Define test cases in your `oad.yaml` or a separate `tests.yaml` file, then run them with `opc test`.
+
+## Defining Tests in OAD
+
+```yaml
+spec:
+  testing:
+    cases:
+      - name: greeting
+        input: "Hello!"
+        expect:
+          contains: ["hello", "help"]
+          maxLatencyMs: 5000
+      
+      - name: product-question
+        input: "What are your pricing plans?"
+        expect:
+          contains: ["pricing", "plan"]
+          notContains: ["error"]
+      
+      - name: edge-case-empty
+        input: ""
+        expect:
+          maxLatencyMs: 2000
+```
+
+## Separate Test File
+
+Create `tests.yaml` alongside your `oad.yaml`:
+
+```yaml
+cases:
+  - name: smoke-test
+    input: "Hi there"
+    expect:
+      maxLatencyMs: 10000
+  - name: faq-check
+    input: "What is your return policy?"
+    expect:
+      contains: ["return", "refund"]
+```
+
+## Running Tests
+
+```bash
+# Run tests
+opc test
+
+# JSON output
+opc test --json
+
+# Custom OAD file
+opc test -f my-agent.yaml
+```
+
+## Test Report
+
+```
+═══════════════════════════════════════════
+  OPC Agent Test Report
+═══════════════════════════════════════════
+
+  ✔ [PASS] greeting (245ms)
+  ✔ [PASS] product-question (312ms)
+  ✘ [FAIL] edge-case (5120ms)
+      → Latency 5120ms exceeded max 2000ms
+
+───────────────────────────────────────────
+  Total: 3  Passed: 2  Failed: 1  Duration: 5677ms
+───────────────────────────────────────────
+```
+
+## Assertions
+
+| Assertion | Description |
+|-----------|-------------|
+| `contains` | Response must include these strings (case-insensitive) |
+| `notContains` | Response must NOT include these strings |
+| `toolCalled` | Specified tools must have been invoked |
+| `maxLatencyMs` | Response must complete within this time |

package/docs/index.md

@@ -1,27 +1,27 @@
----
-layout: home
-hero:
-  name: OPC Agent
-  text: Open Agent Framework
-  tagline: Build, test, and run AI Agents for business workstations
-  actions:
-    - theme: brand
-      text: Get Started
-      link: /guide/getting-started
-    - theme: alt
-      text: View on GitHub
-      link: https://github.com/Deepleaper/opc-agent
-features:
-  - title: 🚀 Quick Start
-    details: Create an agent in under 2 minutes with 13 built-in templates
-  - title: 📝 OAD Schema
-    details: Declarative YAML-based agent definition with full validation
-  - title: 🔌 Multi-Channel
-    details: Web, Telegram, Slack, WeChat, Email, Voice, WebSocket
-  - title: 🧪 Testing Framework
-    details: Define test cases in OAD, run with `opc test`, get pass/fail reports
-  - title: 📊 Analytics
-    details: Track messages, LLM calls, tool usage, and errors with built-in analytics
-  - title: 🌍 i18n
-    details: English, Chinese, and Japanese out of the box
----
+---
+layout: home
+hero:
+  name: OPC Agent
+  text: Open Agent Framework
+  tagline: Build, test, and run AI Agents for business workstations
+  actions:
+    - theme: brand
+      text: Get Started
+      link: /guide/getting-started
+    - theme: alt
+      text: View on GitHub
+      link: https://github.com/Deepleaper/opc-agent
+features:
+  - title: 🚀 Quick Start
+    details: Create an agent in under 2 minutes with 13 built-in templates
+  - title: 📝 OAD Schema
+    details: Declarative YAML-based agent definition with full validation
+  - title: 🔌 Multi-Channel
+    details: Web, Telegram, Slack, WeChat, Email, Voice, WebSocket
+  - title: 🧪 Testing Framework
+    details: Define test cases in OAD, run with `opc test`, get pass/fail reports
+  - title: 📊 Analytics
+    details: Track messages, LLM calls, tool usage, and errors with built-in analytics
+  - title: 🌍 i18n
+    details: English, Chinese, and Japanese out of the box
+---

package/docs/zh/api/cli.md

@@ -1,54 +1,54 @@
-# CLI 命令参考
-
-## 完整命令列表
-
-| 命令 | 说明 |
-|------|------|
-| `opc init [name]` | 创建新智能体项目（交互式） |
-| `opc create <name>` | 从模板快速创建 |
-| `opc run` | 启动智能体（Web 服务） |
-| `opc chat` | 命令行交互对话 |
-| `opc test` | 运行测试用例 |
-| `opc analytics` | 查看使用分析 |
-| `opc info` | 查看智能体信息 |
-| `opc build` | 校验 OAD 配置 |
-| `opc dev` | 热重载开发模式 |
-| `opc deploy` | 部署智能体 |
-| `opc publish` | 发布到市场 |
-| `opc install <source>` | 从包安装智能体 |
-| `opc search <query>` | 搜索 OPC 市场 |
-| `opc stats` | 查看运行时统计 |
-| `opc kb add <file>` | 添加知识库文件 |
-| `opc kb search <query>` | 搜索知识库 |
-| `opc tool list` | 列出 MCP 工具 |
-| `opc workflow run <name>` | 运行工作流 |
-| `opc version-mgmt list` | 列出保存的版本 |
-
-## 通用选项
-
-- `-f, --file <file>` — OAD 文件路径（默认：`oad.yaml`）
-- `-t, --template <name>` — 模板名称
-- `-p, --port <port>` — 端口覆盖
-- `--json` — JSON 格式输出（用于 test/analytics）
-
-## 常用示例
-
-```bash
-# 用模板创建项目
-opc init my-bot -t teacher
-
-# 运行测试，输出 JSON
-opc test --json
-
-# 查看分析数据
-opc analytics
-
-# 部署到 OpenClaw
-opc deploy --target openclaw --install
-
-# 添加文件到知识库
-opc kb add ./docs/product-manual.pdf
-
-# 搜索知识库
-opc kb search "退货政策"
-```
+# CLI 命令参考
+
+## 完整命令列表
+
+| 命令 | 说明 |
+|------|------|
+| `opc init [name]` | 创建新智能体项目（交互式） |
+| `opc create <name>` | 从模板快速创建 |
+| `opc run` | 启动智能体（Web 服务） |
+| `opc chat` | 命令行交互对话 |
+| `opc test` | 运行测试用例 |
+| `opc analytics` | 查看使用分析 |
+| `opc info` | 查看智能体信息 |
+| `opc build` | 校验 OAD 配置 |
+| `opc dev` | 热重载开发模式 |
+| `opc deploy` | 部署智能体 |
+| `opc publish` | 发布到市场 |
+| `opc install <source>` | 从包安装智能体 |
+| `opc search <query>` | 搜索 OPC 市场 |
+| `opc stats` | 查看运行时统计 |
+| `opc kb add <file>` | 添加知识库文件 |
+| `opc kb search <query>` | 搜索知识库 |
+| `opc tool list` | 列出 MCP 工具 |
+| `opc workflow run <name>` | 运行工作流 |
+| `opc version-mgmt list` | 列出保存的版本 |
+
+## 通用选项
+
+- `-f, --file <file>` — OAD 文件路径（默认：`oad.yaml`）
+- `-t, --template <name>` — 模板名称
+- `-p, --port <port>` — 端口覆盖
+- `--json` — JSON 格式输出（用于 test/analytics）
+
+## 常用示例
+
+```bash
+# 用模板创建项目
+opc init my-bot -t teacher
+
+# 运行测试，输出 JSON
+opc test --json
+
+# 查看分析数据
+opc analytics
+
+# 部署到 OpenClaw
+opc deploy --target openclaw --install
+
+# 添加文件到知识库
+opc kb add ./docs/product-manual.pdf
+
+# 搜索知识库
+opc kb search "退货政策"
+```

package/docs/zh/api/oad-schema.md

@@ -1,87 +1,87 @@
-# OAD Schema v1 规范
-
-**OAD**（Open Agent Definition）是智能体的声明式定义格式，支持 YAML 和 JSON。
-
-## 完整 Schema
-
-```yaml
-apiVersion: opc/v1          # 必填。API 版本，目前固定为 "opc/v1"
-kind: Agent                  # 必填。资源类型，目前固定为 "Agent"
-
-metadata:
-  name: string               # 必填。智能体标识名
-  version: string            # 语义版本号，默认 "1.0.0"
-  description: string        # 可选。人类可读的描述
-  author: string             # 可选。作者
-  license: string            # 默认 "Apache-2.0"
-  marketplace:               # 可选。市场配置
-    certified: boolean       # 默认 false
-    category: string         # 如 "customer-service"
-
-spec:
-  provider:                  # 大语言模型供应商
-    default: string          # 默认供应商，默认 "deepseek"
-    allowed: string[]        # 允许的供应商列表，默认 ["openai", "deepseek", "qwen"]
-  model: string              # 模型名称，默认 "deepseek-chat"
-  systemPrompt: string       # 系统提示词
-
-  skills:                    # 技能列表
-    - name: string           # 技能标识
-      description: string    # 技能说明
-      config: object         # 可选。技能配置
-
-  channels:                  # 通信渠道
-    - type: web|websocket|telegram|slack|wechat|feishu|email|voice|webhook
-      port: number           # Web 渠道的端口
-      config: object         # 可选。渠道配置
-
-  memory:
-    shortTerm: boolean       # 开启对话记忆，默认 true
-    longTerm: boolean        # 开启持久化记忆，默认 false
-    provider: string         # 记忆后端（可选）
-
-  testing:
-    cases:                   # 测试用例
-      - name: string
-        input: string
-        expect:
-          contains: string[]
-          notContains: string[]
-          toolCalled: string[]
-          maxLatencyMs: number
-
-  rateLimits:
-    perUser:
-      maxRequests: number
-      windowMs: number
-    perProvider:
-      maxRequests: number
-      windowMs: number
-
-  cache:
-    enabled: boolean
-    ttlMs: number
-    maxEntries: number
-
-  dtv:
-    trust:
-      level: sandbox|verified|certified|listed  # 默认 "sandbox"
-    value:
-      metrics: string[]      # 要追踪的指标，默认 []
-```
-
-## 校验
-
-OAD 文件使用 Zod schema 校验。用 CLI 校验：
-
-```bash
-opc build -f oad.yaml
-```
-
-或在代码中校验：
-
-```typescript
-import { validateOAD } from 'opc-agent';
-
-const config = validateOAD(yamlData);
-```
+# OAD Schema v1 规范
+
+**OAD**（Open Agent Definition）是智能体的声明式定义格式，支持 YAML 和 JSON。
+
+## 完整 Schema
+
+```yaml
+apiVersion: opc/v1          # 必填。API 版本，目前固定为 "opc/v1"
+kind: Agent                  # 必填。资源类型，目前固定为 "Agent"
+
+metadata:
+  name: string               # 必填。智能体标识名
+  version: string            # 语义版本号，默认 "1.0.0"
+  description: string        # 可选。人类可读的描述
+  author: string             # 可选。作者
+  license: string            # 默认 "Apache-2.0"
+  marketplace:               # 可选。市场配置
+    certified: boolean       # 默认 false
+    category: string         # 如 "customer-service"
+
+spec:
+  provider:                  # 大语言模型供应商
+    default: string          # 默认供应商，默认 "deepseek"
+    allowed: string[]        # 允许的供应商列表，默认 ["openai", "deepseek", "qwen"]
+  model: string              # 模型名称，默认 "deepseek-chat"
+  systemPrompt: string       # 系统提示词
+
+  skills:                    # 技能列表
+    - name: string           # 技能标识
+      description: string    # 技能说明
+      config: object         # 可选。技能配置
+
+  channels:                  # 通信渠道
+    - type: web|websocket|telegram|slack|wechat|feishu|email|voice|webhook
+      port: number           # Web 渠道的端口
+      config: object         # 可选。渠道配置
+
+  memory:
+    shortTerm: boolean       # 开启对话记忆，默认 true
+    longTerm: boolean        # 开启持久化记忆，默认 false
+    provider: string         # 记忆后端（可选）
+
+  testing:
+    cases:                   # 测试用例
+      - name: string
+        input: string
+        expect:
+          contains: string[]
+          notContains: string[]
+          toolCalled: string[]
+          maxLatencyMs: number
+
+  rateLimits:
+    perUser:
+      maxRequests: number
+      windowMs: number
+    perProvider:
+      maxRequests: number
+      windowMs: number
+
+  cache:
+    enabled: boolean
+    ttlMs: number
+    maxEntries: number
+
+  dtv:
+    trust:
+      level: sandbox|verified|certified|listed  # 默认 "sandbox"
+    value:
+      metrics: string[]      # 要追踪的指标，默认 []
+```
+
+## 校验
+
+OAD 文件使用 Zod schema 校验。用 CLI 校验：
+
+```bash
+opc build -f oad.yaml
+```
+
+或在代码中校验：
+
+```typescript
+import { validateOAD } from 'opc-agent';
+
+const config = validateOAD(yamlData);
+```