OpenClaw 文档知识库 / OpenClaw Knowledge Base

OpenClaw 文档知识库 - 搜索与同步 / OpenClaw Documentation Knowledge Base - Search & Sync

Security Scan

The skill appears to implement a coherent documentation search-and-sync tool, but the SKILL.md triggered prompt-injection patterns and the code ingests remote docs (some of which the indexer specifically strips <AgentInstructions> from), so you should review the fetched content and run in a safe environment before trusting it.

Purpose & Capability

Name/description (knowledge base search & sync) matches the included scripts: sync.js fetches docs.openclaw.ai and saves markdown to a local docs/ directory; index.js builds a local JSON index used by search.js. Files and behaviors are proportionate to the stated purpose.

Instruction Scope

SKILL.md only instructs running the bundled node scripts (search and sync). The sync fetches remote markdown and writes it to a local docs/ directory and manifest; the indexer reads those files. This is expected, but the skill explicitly strips <AgentInstructions> tags from fetched pages — which indicates it anticipates remote documents may contain embedded agent instructions or injection vectors. Combined with the scanner flags, this is notable: the skill can ingest arbitrary remote text that may be used later as AI input, so verify source trustworthiness and/or sanitize fetched content before using results in an LLM.

Install Mechanism

No install spec is present (instruction-only install). The package is shipped as files in the skill bundle and requires node >=18. No external downloads or installers are executed during install, which minimizes supply-chain risk.

Credentials

The skill requests no environment variables or credentials and uses no external API keys. It only reads/writes local files (docs/, vault-index.json, .scrape-manifest.json) and performs HTTP GETs to docs.openclaw.ai (BASE_URL). The requested permissions are proportional to a documentation sync/indexer.

Persistence & Privilege

always is false and the skill does not modify other skills or global agent configuration. It persists scraped documents and a manifest under the skill's repo path (docs/ and .scrape-manifest.json), which is expected but means it will write to disk in the current workspace.

Scan Findings in Context

[system-prompt-override] unexpected: The pre-scan detected patterns that look like attempts to override system prompts. That is not expected for a documentation indexer. The code does remove <AgentInstructions> blocks from fetched docs, suggesting the author is aware of potential embedded agent instructions in source content — nevertheless, presence of prompt-override patterns in SKILL.md or bundled content warrants manual review.

[unicode-control-chars] unexpected: Unicode control characters can be used to obfuscate malicious instructions or hide payloads inside text. A docs fetcher/indexer might encounter such characters in remote content, but their detection in the skill bundle is unexpected and should be inspected (look for invisible characters in SKILL.md and any fetched .md files).

What to consider before installing

This skill is largely coherent with its stated purpose, but take these precautions before installing: 1) Only use it if you trust https://docs.openclaw.ai — the sync fetches and stores remote markdown and that content may later be fed to an LLM. 2) Inspect the docs/ directory and .scrape-manifest.json after a sync; search for <AgentInstructions> or suspicious invisible characters. 3) Run the sync in a sandboxed environment (not on a machine with sensitive files or keys) to avoid accidental contamination of your workspace. 4) If you plan to feed search results to an AI, either sanitize the content programmatically or manually review examples to ensure no prompt-injection payloads are present. 5) If you need higher assurance, request the upstream source code or an author explanation about why prompt-injection patterns appear in the bundle.

本技能提供 OpenClaw 官方文档的搜索与同步功能。 / This skill provides search and sync capabilities for OpenClaw official documentation.

功能概览 / Features

• 全文搜索 - 快速搜索 366+ 文档 / Full-text search across 366+ documents
• 增量同步 - 从官网获取最新文档 / Incremental sync from official docs
• 分类浏览 - 按类别查看文档 / Browse by category
• JSON 输出 - 支持 AI 调用 / AI-friendly JSON output

命令 / Commands

搜索 / Search

# 基本搜索 / Basic search
node scripts/search.js "memory"

# 分类过滤 / Category filter
node scripts/search.js "docker" --category install

# JSON 输出（供 AI 调用）/ JSON output (for AI)
node scripts/search.js "session" --format json --limit 5

# 列出所有分类 / List all categories
node scripts/search.js --categories

# 查看帮助 / Show help
node scripts/search.js --help

同步 / Sync

# 查看同步统计 / Show sync stats
node scripts/sync.js --stats

# 增量同步（5并发）/ Incremental sync (5 concurrent)
node scripts/sync.js

# 强制全量更新 / Force full refresh
node scripts/sync.js --force

# 自定义并发数 / Custom parallel
node scripts/sync.js --parallel=10 --delay=50

分类 / Categories

分类	说明
automation	自动化任务（定时任务、钩子）
channels	消息渠道（Telegram、Discord 等）
cli	命令行工具参考
concepts	核心概念（Agent、Session、Memory 等）
gateway	Gateway 配置与协议
install	安装指南（Docker、Kubernetes 等）
plugins	插件开发
providers	AI 模型提供商
tools	工具参考

使用示例 / Examples

# 搜索 memory 相关文档
node scripts/search.js "memory" --limit 10

# 搜索 AI 提供商
node scripts/search.js "openai" --category providers

# 搜索渠道相关
node scripts/search.js "telegram" --category channels

# 搜索安装指南
node scripts/search.js "docker kubernetes" --category install

# AI 友好的 JSON 输出
node scripts/search.js "session" --format json --limit 3

输出格式 / Output

JSON 模式下的返回格式：

{
  "query": "session",
  "total": 5,
  "returned": 3,
  "results": [
    {
      "path": "concepts/session.md",
      "title": "Session Management",
      "category": "concepts",
      "score": 12.5,
      "summary": "Session transcripts are stored..."
    }
  ]
}