← 返回 Skills 市场
OpenClaw Docs Search + Config Patterns
作者
karmanverma
· GitHub ↗
· v1.1.0
1278
总下载
0
收藏
3
当前安装
5
版本数
在 OpenClaw 中安装
/install search-openclaw-docs
功能描述
MANDATORY before any openclaw.json changes. Prevents config breakage via embedded anti-patterns and correct patterns. Use when configuring OpenClaw (bindings, channels, sessions, cron, heartbeat) or troubleshooting config issues.
安全使用建议
This skill appears to do what it claims: offline indexing/search of OpenClaw docs and bundled reference files. Before installing or running the scripts: 1) Inspect the scripts (they run locally and read files under your home directory and system docs path). 2) Be prepared to run npm install (better-sqlite3 is a native module and may require build tools). 3) The skill will create a local SQLite index at ~/.openclaw/docs-index/openclaw-docs.sqlite — ensure you are comfortable with it writing there. 4) No credentials or network access are requested, but if you plan to add the skill as a trigger in openclaw.json or follow its post-install suggestions, review those changes before applying. 5) Note a minor incongruence: the registry shows no automated install spec even though SKILL.md/package.json expect an npm install — remember to run the install steps manually or via your normal package workflow.
功能分析
Type: OpenClaw Skill
Name: search-openclaw-docs
Version: 1.1.0
The OpenClaw AgentSkills skill bundle 'search-openclaw-docs' is designed for offline documentation search and configuration pattern guidance. It uses Node.js and `better-sqlite3` to build and query a local SQLite FTS5 index from OpenClaw's own documentation files (e.g., `/usr/lib/node_modules/openclaw/docs`). All operations, including file system access for indexing and search, are confined to local paths (`~/.openclaw/docs-index` for the index, and system paths for OpenClaw docs). The skill explicitly states 'No network calls - fully offline'. Instructions in `SKILL.md`, `AGENTS.md`, and `POST_INSTALL.md` guide the AI agent to use the local search scripts and follow configuration best practices, without any evidence of prompt injection for malicious intent, data exfiltration, or unauthorized actions. The JSON snippets in `references/*.md` are configuration examples, not executable code within the skill.
能力评估
Purpose & Capability
The name/description (OpenClaw docs search + config patterns) match the code and instructions: Node scripts and libs build/query a local FTS5 SQLite index of OpenClaw docs and ship embedded reference files. Required binary is 'node', and the only dependency is better-sqlite3 (an SQLite binding) — all proportional to a local docs search tool.
Instruction Scope
SKILL.md restricts runtime actions to local tasks: reading AGENTS.md, running scripts (docs-search.js, docs-index.js, docs-status.js), and reading local doc files (e.g., /usr/lib/node_modules/openclaw/docs/ and files under ~/.openclaw). It explicitly claims 'No network calls - fully offline.' There are no instructions to read unrelated secrets or to transmit data externally.
Install Mechanism
Registry had no formal install spec, but SKILL.md and package.json instruct installing the native npm dependency better-sqlite3 and running a local index rebuild. Using better-sqlite3 is expected for a local SQLite index but requires native build tools on some systems. The installation approach is local (npm) and does not download arbitrary archives or call remote URLs beyond the repo URL in metadata.
Credentials
The skill requires no environment variables, no credentials, and no config paths beyond local locations (HOME-based index and system docs path). Access to ~/.openclaw and /usr/lib/node_modules/openclaw/docs/ is necessary for its function and is proportionate to the stated purpose.
Persistence & Privilege
Skill flags are default (always:false, user-invocable, model invocation allowed). It does not request permanent/always-on presence and does not modify other skills or system-wide agent settings by itself. It recommends optional triggers and adding workflow text to AGENTS.md, which are benign and user-controlled.
如何使用
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install search-openclaw-docs - 安装完成后,直接呼叫该 Skill 的名称或使用
/search-openclaw-docs触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.1.0
Added embedded config patterns and agent workflow: 8 reference files with anti-patterns (bindings, channels, sessions, heartbeat, cron), AGENTS.md navigation, decision tree. Prevents config breakage with instant pattern access.
v2.2.0
Removed all network code. Pure FTS5 keyword search - fully offline, zero network calls.
v2.1.0
SECURITY: Default to FTS5-only (no network calls). Embeddings now require explicit opt-in via OPENCLAW_DOCS_EMBEDDINGS=true
v2.0.2
Added POST_INSTALL.md setup guide and post-build tips for AGENTS.md config
v2.0.1
OpenClaw agent skill for semantic search. FTS5 + optional vector rerank. Returns file paths to read.
元数据
常见问题
OpenClaw Docs Search + Config Patterns 是什么?
MANDATORY before any openclaw.json changes. Prevents config breakage via embedded anti-patterns and correct patterns. Use when configuring OpenClaw (bindings, channels, sessions, cron, heartbeat) or troubleshooting config issues. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 1278 次。
如何安装 OpenClaw Docs Search + Config Patterns?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install search-openclaw-docs」即可一键安装,无需额外配置。
OpenClaw Docs Search + Config Patterns 是免费的吗?
是的,OpenClaw Docs Search + Config Patterns 完全免费(开源免费),可自由下载、安装和使用。
OpenClaw Docs Search + Config Patterns 支持哪些平台?
OpenClaw Docs Search + Config Patterns 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 OpenClaw Docs Search + Config Patterns?
由 karmanverma(@karmanverma)开发并维护,当前版本 v1.1.0。
推荐 Skills