feat: adapt preloaded skills to smart-reasoning agent
This commit is contained in:
+169
-136
@@ -3,6 +3,7 @@
|
||||
## 概述
|
||||
|
||||
Agent Skills 是一种让 Agent 通过阅读"使用说明书"来学习新能力的扩展机制。与传统的硬编码工具不同,Skills 通过注入到 System Prompt 来扩展 Agent 的能力,遵循 **Progressive Disclosure(渐进式披露)** 的设计理念。
|
||||
目前仅支持带**智能推理**能力的智能体使用。前端可在智能体的编辑页面找到相关配置
|
||||
|
||||
### 核心特性
|
||||
|
||||
@@ -83,32 +84,15 @@ with pdfplumber.open("document.pdf") as pdf:
|
||||
print(text)
|
||||
```
|
||||
|
||||
## Available Operations
|
||||
|
||||
1. **Text Extraction**: Extract text content from PDF pages
|
||||
2. **Table Extraction**: Extract tabular data from PDFs
|
||||
...
|
||||
```
|
||||
|
||||
### 元数据验证规则
|
||||
## 元数据验证规则
|
||||
|
||||
| 字段 | 要求 |
|
||||
|------|------|
|
||||
| `name` | 1-50 字符,仅允许 `a-z`, `0-9`, `-`, `_`,不能是保留词 |
|
||||
| `name` | 1-50 字符,仅允许汉字、英文字母、数字,不能是保留词 |
|
||||
| `description` | 1-500 字符,描述技能用途和触发条件 |
|
||||
|
||||
**保留词**:`system`, `default`, `internal`, `core`, `base`, `root`, `admin`
|
||||
|
||||
### 最佳实践
|
||||
|
||||
**name 命名**:
|
||||
- ✅ `pdf-processing`, `code_review`, `api-client`
|
||||
- ❌ `PDF Processing`, `my skill`, `system`
|
||||
|
||||
**description 编写**:
|
||||
- 清晰描述技能的功能
|
||||
- 包含触发条件(如 "when working with PDF files")
|
||||
- 避免过于模糊的描述
|
||||
|
||||
## 配置
|
||||
|
||||
@@ -202,96 +186,174 @@ Skills 功能通过两个工具与 Agent 交互:
|
||||
- Ruby (`.rb`)
|
||||
- Go (`.go`)
|
||||
|
||||
## 预加载技能(Preloaded Skills)
|
||||
|
||||
系统内置了以下 5 个预加载技能,用于增强知识库问答和文档处理能力:
|
||||
|
||||
### 1. citation-generator - 引用生成器
|
||||
|
||||
**用途**:自动生成规范引用格式
|
||||
|
||||
**触发场景**:
|
||||
- 需要生成参考文献
|
||||
- 标注知识库内容出处
|
||||
- 要求提供引用信息
|
||||
|
||||
**核心能力**:
|
||||
| 功能 | 说明 |
|
||||
|------|------|
|
||||
| 来源标注 | 为回答中使用的每个知识点标注来源 |
|
||||
| 格式化引用 | 支持 APA、MLA、Chicago、简化格式 |
|
||||
| 参考文献列表 | 在回答末尾生成完整的参考文献列表 |
|
||||
|
||||
**简化引用格式示例**:
|
||||
```
|
||||
根据公司政策[员工手册2024.pdf, 第15页],年假申请需提前...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 2. data-processor - 数据处理器
|
||||
|
||||
**用途**:数据处理与分析
|
||||
|
||||
**触发场景**:
|
||||
- "分析这些数据"、"统计一下"、"计算总数/平均值"
|
||||
- "转换为 JSON/CSV 格式"
|
||||
- "提取关键信息"、"整理成表格"
|
||||
- "生成报告"、"数据汇总"
|
||||
|
||||
**核心能力**:
|
||||
| 功能 | 说明 |
|
||||
|------|------|
|
||||
| 数据分析 | 对检索到的文档数据进行统计分析 |
|
||||
| 格式转换 | JSON/CSV/Markdown 等格式相互转换 |
|
||||
| 数据提取 | 从非结构化文本中提取结构化信息 |
|
||||
| 报告生成 | 生成数据分析报告和摘要 |
|
||||
|
||||
**可用脚本**:
|
||||
- `scripts/analyze.py` - 数据分析脚本
|
||||
- `scripts/format_converter.py` - 格式转换脚本
|
||||
- `scripts/extract_info.py` - 信息提取脚本
|
||||
|
||||
**脚本使用示例**:
|
||||
```bash
|
||||
# 数据分析
|
||||
echo '{"items": [1, 2, 3, 4, 5]}' | python scripts/analyze.py
|
||||
|
||||
# 格式转换(JSON 转 CSV)
|
||||
echo '[{"name": "A", "value": 1}]' | python scripts/format_converter.py --to csv
|
||||
|
||||
# 信息提取
|
||||
echo "2024年销售额为100万元" | python scripts/extract_info.py
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 3. doc-coauthoring - 文档协作 (源于Claude官方Skill)
|
||||
|
||||
**用途**:引导用户完成结构化文档创作
|
||||
|
||||
**触发场景**:
|
||||
- 编写文档:"write a doc"、"draft a proposal"、"create a spec"
|
||||
- 文档类型:PRD、设计文档、决策文档、RFC
|
||||
|
||||
**工作流程**:
|
||||
|
||||
```
|
||||
Stage 1: 上下文收集 (Context Gathering)
|
||||
↓
|
||||
Stage 2: 细化与结构 (Refinement & Structure)
|
||||
↓
|
||||
Stage 3: 读者测试 (Reader Testing)
|
||||
```
|
||||
|
||||
**三阶段说明**:
|
||||
| 阶段 | 目标 | 关键活动 |
|
||||
|------|------|----------|
|
||||
| Stage 1 | 缩小用户与 Claude 之间的信息差 | 元信息提问、上下文收集、澄清问题 |
|
||||
| Stage 2 | 逐节构建文档 | 头脑风暴、筛选整理、迭代修改 |
|
||||
| Stage 3 | 测试文档对读者的效果 | 预测读者问题、子代理测试、修复盲点 |
|
||||
|
||||
---
|
||||
|
||||
### 4. document-analyzer - 文档分析器
|
||||
|
||||
**用途**:深度分析文档结构和内容
|
||||
|
||||
**触发场景**:
|
||||
- 分析文档结构
|
||||
- 提取关键信息
|
||||
- 识别文档类型
|
||||
- 进行内容质量评估
|
||||
|
||||
**核心能力**:
|
||||
| 功能 | 说明 |
|
||||
|------|------|
|
||||
| 结构分析 | 识别文档的章节层级、组织架构 |
|
||||
| 关键信息提取 | 提取核心论点、关键数据、重要结论 |
|
||||
| 文档类型识别 | 判断文档类型(报告、手册、论文、合同等) |
|
||||
| 内容质量评估 | 评估文档的完整性、一致性、可读性 |
|
||||
|
||||
**分析流程**:
|
||||
1. **文档概览** - 获取文档基本信息
|
||||
2. **结构分析** - 识别标题层级、章节组织
|
||||
3. **内容提取** - 提取核心主题、关键论点、支撑数据
|
||||
4. **质量评估** - 评估完整性、一致性、清晰度
|
||||
|
||||
---
|
||||
|
||||
### 5. summary-generator - 摘要生成器
|
||||
|
||||
**用途**:生成多层级文档摘要
|
||||
|
||||
**触发场景**:
|
||||
- 生成内容摘要
|
||||
- 提取要点
|
||||
- 创建不同长度的文档概述
|
||||
|
||||
**摘要层级**:
|
||||
| 层级 | 名称 | 长度 | 说明 |
|
||||
|------|------|------|------|
|
||||
| Level 1 | 一句话摘要 | ~20字 | 核心内容概括 |
|
||||
| Level 2 | 要点摘要 | 3-5个要点 | **默认层级**,提取最重要的要点 |
|
||||
| Level 3 | 段落摘要 | 100-200字 | 1-2段文字全面概括 |
|
||||
| Level 4 | 详细摘要 | 章节式 | 按文档结构分章节摘要 |
|
||||
|
||||
**摘要原则**:
|
||||
- 准确性:摘要必须准确反映原文内容
|
||||
- 完整性:不遗漏重要信息
|
||||
- 简洁性:用最少的文字表达核心内容
|
||||
- 客观性:不添加个人观点
|
||||
|
||||
---
|
||||
|
||||
### 技能目录结构
|
||||
|
||||
预加载技能位于 `skills/preloaded/` 目录下:
|
||||
|
||||
```
|
||||
skills/preloaded/
|
||||
├── citation-generator/
|
||||
│ └── SKILL.md
|
||||
├── data-processor/
|
||||
│ ├── SKILL.md
|
||||
│ └── scripts/
|
||||
│ ├── analyze.py
|
||||
│ ├── format_converter.py
|
||||
│ └── extract_info.py
|
||||
├── doc-coauthoring/
|
||||
│ └── SKILL.md
|
||||
├── document-analyzer/
|
||||
│ └── SKILL.md
|
||||
└── summary-generator/
|
||||
└── SKILL.md
|
||||
```
|
||||
|
||||
## 创建自定义 Skill
|
||||
|
||||
### 第一步:创建目录结构
|
||||
暂时不支持用户自主创建自定义 Skill
|
||||
|
||||
```bash
|
||||
mkdir -p my-skills/code-review
|
||||
cd my-skills/code-review
|
||||
```
|
||||
|
||||
### 第二步:编写 SKILL.md
|
||||
|
||||
```markdown
|
||||
---
|
||||
name: code-review
|
||||
description: Review code for best practices, security issues, and performance. Use when the user asks to review, analyze, or improve code quality.
|
||||
---
|
||||
|
||||
# Code Review Skill
|
||||
|
||||
This skill helps analyze code for quality and security issues.
|
||||
|
||||
## How to Use
|
||||
|
||||
When reviewing code:
|
||||
|
||||
1. Check for common security vulnerabilities
|
||||
2. Identify performance bottlenecks
|
||||
3. Suggest best practice improvements
|
||||
|
||||
## Security Checklist
|
||||
|
||||
- [ ] SQL Injection prevention
|
||||
- [ ] XSS protection
|
||||
- [ ] Input validation
|
||||
- [ ] Authentication checks
|
||||
|
||||
## Performance Tips
|
||||
|
||||
- Avoid N+1 queries
|
||||
- Use appropriate data structures
|
||||
- Consider caching strategies
|
||||
```
|
||||
|
||||
### 第三步:添加辅助脚本(可选)
|
||||
|
||||
创建 `scripts/lint.py`:
|
||||
|
||||
```python
|
||||
#!/usr/bin/env python3
|
||||
"""Simple code linter for demonstration."""
|
||||
import sys
|
||||
import json
|
||||
|
||||
def lint_code(filepath):
|
||||
issues = []
|
||||
with open(filepath) as f:
|
||||
for i, line in enumerate(f, 1):
|
||||
if len(line) > 120:
|
||||
issues.append({
|
||||
"line": i,
|
||||
"issue": "Line too long",
|
||||
"severity": "warning"
|
||||
})
|
||||
if "eval(" in line:
|
||||
issues.append({
|
||||
"line": i,
|
||||
"issue": "Avoid using eval()",
|
||||
"severity": "error"
|
||||
})
|
||||
return issues
|
||||
|
||||
if __name__ == "__main__":
|
||||
if len(sys.argv) < 2:
|
||||
print("Usage: lint.py <filepath>")
|
||||
sys.exit(1)
|
||||
|
||||
result = lint_code(sys.argv[1])
|
||||
print(json.dumps(result, indent=2))
|
||||
```
|
||||
|
||||
### 第四步:配置 Agent
|
||||
|
||||
将 Skill 目录添加到 Agent 配置:
|
||||
|
||||
```json
|
||||
{
|
||||
"skills_enabled": true,
|
||||
"skill_dirs": ["/path/to/my-skills"]
|
||||
}
|
||||
```
|
||||
|
||||
## 沙箱安全机制
|
||||
|
||||
@@ -450,33 +512,4 @@ go run ./cmd/skills-demo/main.go
|
||||
- `skill name too long`: 名称超过 50 字符
|
||||
- `skill name contains invalid characters`: 包含非法字符
|
||||
- `skill name is reserved`: 使用了保留词
|
||||
- `skill description too long`: 描述超过 500 字符
|
||||
|
||||
## 运行 Demo
|
||||
|
||||
```bash
|
||||
cd /path/to/WeKnora
|
||||
go run ./cmd/skills-demo/main.go
|
||||
```
|
||||
|
||||
输出示例:
|
||||
|
||||
```
|
||||
=======================================================================
|
||||
Agent Skills Demo - Progressive Disclosure in Action
|
||||
=======================================================================
|
||||
|
||||
📁 Skills directory: /path/to/WeKnora/examples/skills
|
||||
|
||||
Step 1: Initialize Sandbox Manager
|
||||
---------------------------------------------------
|
||||
✅ Sandbox initialized (type: local)
|
||||
|
||||
Step 2: Initialize Skills Manager
|
||||
---------------------------------------------------
|
||||
✅ Discovered 1 skills
|
||||
|
||||
...
|
||||
|
||||
🎉 Demo completed successfully!
|
||||
```
|
||||
- `skill description too long`: 描述超过 500 字符
|
||||
Reference in New Issue
Block a user