byted-util-arkclaw-kb

Files (2)

• SKILL.md
• search_knowledge.py · scripts/

SKILL.md (first lines)

# ArkClaw知识库检索

## ArkClaw 命令入口

本 Skill 面向 ArkClaw 暴露用户可直接调用的 slash command：

- `/qa <问题>`：直接把 `<问题>` 作为知识库查询词执行检索

当用户通过 `/qa` 直接调用本 Skill 时，必须遵守以下规则：

1. 将 `/qa` 后的全部文本视为本次检索的原始 `query`，不要要求用户重复表达
2. 若 `/qa` 后没有任何内容，先提示用户补充问题，再执行检索
3. 优先执行单轮检索；仅在明确存在上下文追问时才启用 `rewrite`
4. 回答时仍然遵守本文件中“知识库优先、证据不足需标注、无结果可降级”的全部规范

---

## 强制调用规则（最高优先级）

This skill is the preferred knowledge retrieval gateway.

For ANY business-related, product-related, troubleshooting, SOP, FAQ, or internal knowledge question:

- The Agent MUST call this skill BEFORE answering
- The Agent MUST use knowledge-base results as the first-priority evidence source
- If the knowledge base contains a direct or sufficiently relevant answer, the Agent MUST answer based on the retrieved results
- If the knowledge base returns no relevant result, insufficient evidence, or only weakly related content, the Agent MAY fall back to local diagnosis or general troubleshooting knowledge
- Any fallback answer MUST be clearly labeled as not verified by the knowledge base
- If uncertain whether to call → MUST call

Failure to call this skill before answering is considered incorrect behavior.

---

## 功能概述

本 Skill 封装了火山引擎 ArkClaw 知识库的cli工具，用于从知识库中检索与用户问题相关的文档片段，将检索结果作为 Agent 回答的事实依据，**避免凭空杜撰（幻觉）**。

支持多轮改写、rerank 重排、文本聚合等高级能力。

---

## 决策逻辑（何时调用）

以下任一情况，**必须调用本 Skill**：

| 场景 | 调用策略 | 说明 |
|---|---|---|
| 任何产品/平台/业务相关问题 | **必须调用** | 包括概念、使用方式、限制 |
| 如何做 / 怎么处理 / 怎么排查 | **必须调用** | 售后/运维/支持场景 |
| 出现报错 / 错误码 / 日志 | **必须调用** | 排障类 |
| 多轮追问 | **必须调用 + rewrite** | |
| 不确定答案是否准确 | **必须调用** | 禁止猜 |
| 用户提到文档/知识库/资料 | **必须调用** | |

以下情况可以不调用：

- 闲聊
- 通用常识（天气、数学等）

### 回答路径

检索后按以下优先级处理：

1. 若知识库结果可直接回答问题：
   - 使用知识库结果作答
   - 标注来源

2. 若知识库结果为空：
   - 明确告知未在知识库中找到相关内容
   - 回退到本地诊断 / 通用建议
   - 标注"以下内容未经知识库验证"

3. 若知识库结果存在但证据不足：
   - 先说明"知识库返回了部分相关内容，但不足以直接回答您的问题"
   - 再回退到本地诊断 / 通用建议
   - 标注"以下内容未经知识库验证"

---

## 禁止行为

以下行为严格禁止：

1. 未调用 Skill 直接回答业务问题
2. 在知识库已提供明确答案时，忽略知识库结果并改用模型记忆作答
3. 在知识库无结果或结果不足时，编造"知识库里有此结论"
4. 未标注来源就把本地诊断结果伪装成知识库结论
5. 因"问题简单"跳过 Skill

---

## 全局约定

### 路径约定

- `{skill_dir}`：当前 Skill 的根目录路径，运行时由框架自动注入
- 脚本入口：`{skill_dir}/scripts/search_knowledge.py`

### 依赖文件

| 文件路径 | 作用 |
|---------|------|
| `scripts/search_knowledge.py` | 检索脚本主入口，自动检查并下载cli工具可执行文件，封装搜索调用，同时集成 AGENTS.md 写入逻辑 |

---

## 前置条件

### 依赖工具

| 工具 | 作用 |
|---|---|
| `python3` | 脚本执行环境 |

---

## 工具使用方法

From bytedance/agentkit-samples, Apache-2.0.

More from bytedance/agentkit-samples