← 返回 Skills 市场
markdownknowledge
作者
aaronjager92
· GitHub ↗
· v1.1.2
· MIT-0
172
总下载
0
收藏
0
当前安装
4
版本数
在 OpenClaw 中安装
/install markdown-knowledge
功能描述
将本地 Markdown 知识库与 OpenClaw 集成,支持语义检索和上下文注入。仅在用户触发时检索(搜索知识库、查一下知识库等),不主动注入。
安全使用建议
What to check before installing/using this skill:
- Understand data access: the skill will read every .md under the configured knowledge_path and write an index file. Remove or relocate any Markdown that contains secrets (API keys, private tokens, passwords) or sensitive personal data before building the index.
- Decide about auto-refresh: some manifests default auto_refresh=true while SKILL.md claims trigger-only retrieval. If you want no background updates or automatic injection, set auto_refresh to false and verify the agent only invokes search when you request it.
- Inspect and control init behavior: running the provided init will attempt to download ripgrep from GitHub and install it to ~/.local/bin. If you prefer not to allow automatic downloads, install ripgrep yourself or edit the script to skip ensure_ripgrep.
- Review index contents: after building, open the index.json to confirm it does not contain unintended secrets before invoking the skill in a shared/online agent session.
- Limit scope: set knowledge_path to a narrow directory containing only documents you are comfortable exposing to the agent; use exclude_patterns to skip folders with sensitive content.
- Run in a safe environment first: consider running build/search locally in an isolated account/container to observe behavior, then integrate into your primary agent once satisfied.
Confidence note: medium — most items are straightforwardly supported by the code, but some contradictory documentation entries (automatic injection vs trigger-only) and the auto-download behavior increase uncertainty; examining runtime config and running a manual build will resolve the remaining questions.
功能分析
Type: OpenClaw Skill
Name: markdown-knowledge
Version: 1.1.2
The skill implements a local Markdown knowledge base with semantic search. The primary security concern is the `ensure_ripgrep` function in `scripts/knowledge_base.py`, which automatically downloads and installs a binary from GitHub (`BurntSushi/ripgrep`) during initialization. While this is intended to improve performance, downloading and executing remote binaries is a high-risk behavior that bypasses standard package management. The rest of the code, including the `SKILL.md` instructions and core logic in `src/knowledge_core.py`, appears aligned with the stated purpose of local document retrieval.
能力标签
能力评估
Purpose & Capability
Name/description match the implemented functionality: the skill scans local Markdown, builds a JSON index, and exposes search/build/stats actions. Declared filesystem permissions (read Markdown, write index) are consistent with purpose. However, some documentation (PROJECT.md, README.md, clawhub.json) asserts features like automatic context injection and auto-refresh which conflict with the top-level SKILL.md claim of 'trigger-only' retrieval.
Instruction Scope
SKILL.md instructs trigger-only behavior, but other included docs repeatedly state 'automatic context injection' and 'real-time sync/auto_refresh'. The code itself exposes actions for search/build/stats (triggered use), but there is a config parameter auto_refresh (default true in some manifests) that could enable background/index refresh behavior. Also the skill will read arbitrary files from the configured knowledge_path and may include their content in search results/formatting — that means any sensitive data present in Markdown could be revealed to the agent when triggered.
Install Mechanism
There is no registry install spec in the package, but scripts/knowledge_base.py's init will attempt to auto-download ripgrep from GitHub releases (https://github.com/BurntSushi/ripgrep/releases/...) and extract it to ~/.local/bin. Downloading and extracting an executable is a higher-risk install step than pure instruction-only; the download host (GitHub releases) is well-known, but the script writes binaries to the user's home area and uses /tmp for temporary files. The skill otherwise does not pull other remote code during runtime.
Credentials
The skill requests no environment variables or external credentials, which matches its described local purpose. However, it will read all Markdown under the configured knowledge_path and write an index file. The included sample index.json demonstrates real user data (including API keys and private values inside Markdown). Because the skill returns document snippets and formatted results to the agent, any secrets embedded in Markdown can be surfaced to the agent and (depending on agent behavior) transmitted beyond the machine. The number of environment/credential requests is low, but the data-access scope (entire Markdown folder) is broad and should be constrained by the user.
Persistence & Privilege
always: false and user-invocable: true. The skill does not request permanent platform-wide inclusion nor does it modify other skills' configurations. It writes its own config/index under its skill directory and can install ripgrep to ~/.local/bin during init, which is limited to the user's account and not a system-wide privilege escalation.
如何使用
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install markdown-knowledge - 安装完成后,直接呼叫该 Skill 的名称或使用
/markdown-knowledge触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
版本历史
v1.1.2
- Added new configuration and metadata files for improved integration: .clawhub/origin.json, _meta.json, config.json, index.json, and src/global_memory.py.
- Updated installation and configuration paths from ~/.openclaw/skills to ~/.openclaw/workspace/skills.
- Updated documentation to reflect new file names and structure.
- Improved documentation for file structure and references.
v1.1.1
markdown-knowledge v1.1.1
- Removed optional global memory module (`src/global_memory.py`), disabling background/global knowledge base injection.
- Clarified that the knowledge base only responds to explicit user triggers; no more background or automatic injections.
- Updated configuration: `auto_refresh` default is now `false`.
- Simplified documentation for privacy and principle of explicit, trigger-only knowledge retrieval.
v1.1.0
- Major refactor of file structure: moved and reorganized code from loose scripts and folders (`lib/`, `actions/`) into `src/` directory.
- Added full documentation and project notes as Markdown in the `references/` folder.
- Enhanced skill trigger patterns for search, rebuild, and stats actions.
- Improved configuration defaults and documentation for index path and knowledge base usage.
- Updated SKILL.md with more detailed usage instructions, new author info, and bilingual help references.
v1.0.0
published my skill with version1.0.0
元数据
常见问题
markdownknowledge 是什么?
将本地 Markdown 知识库与 OpenClaw 集成,支持语义检索和上下文注入。仅在用户触发时检索(搜索知识库、查一下知识库等),不主动注入。 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 172 次。
如何安装 markdownknowledge?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install markdown-knowledge」即可一键安装,无需额外配置。
markdownknowledge 是免费的吗?
是的,markdownknowledge 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
markdownknowledge 支持哪些平台?
markdownknowledge 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 markdownknowledge?
由 aaronjager92(@aaronjager92)开发并维护,当前版本 v1.1.2。
推荐 Skills