SuperAPI AI 工具集

okf

通用与其它

查看项目

更新于 10-15 21:36

技能介绍

用途:okf 技能用于创建和维护 Open Knowledge Format(OKF)知识包。OKF 是厂商中立的格式,把知识表示为带 YAML frontmatter 的纯 Markdown 文件,按目录层级组织,不绑定任何智能体、框架、模型提供商或服务系统。一个 bundle 就是一个目录,可版本控制、可移植、无锁定,人和大模型都能读,也能被任何读取 Markdown 的工具消费。

主要能力:初始化新的空 OKF bundle;编写或编辑概念文档(每个 .md 一个概念);生成或刷新 index.md(渐进式披露)与 log.md(历史);校验现有 bundle 是否符合 OKF v0.1;把 bundle 渲染为自包含的交互式图查看器 viz.html。若要把已有笔记或目录导出转换为 OKF bundle,应改用配套的 okf-refactor 技能。

必要规则:每个非保留 .md 文件必须有可解析的 YAML frontmatter,且 frontmatter 必须包含非空 type;保留文件名 index.md、log.md 遵循特殊结构且不带 frontmatter(唯一例外是 bundle 根 index.md 可带 okf_version);交叉链接用普通 Markdown 链接,优先使用 bundle 相对绝对路径(如 /tables/orders.md)。建议同时输出 title、description,资产类再加 resource。

使用方式:初始化时确认路径、创建根目录、按领域决定顶层分组,写根 index.md 声明版本并链接分组,可选写入 log.md 条目。概念文档放在 <group>/<slug>.md,slug 用 kebab-case。渲染查看器命令:python3 ${CLAUDE_PLUGIN_ROOT}/skills/okf/scripts/render_okf_viewer.py ./bundles/my_bundle,可加 --title 与 --out 参数。校验命令:python3 ${CLAUDE_PLUGIN_ROOT}/skills/okf/scripts/validate_okf.py ./bundles/my_bundle。查看器从 related frontmatter、[[slug]] wikilink 或 Markdown 链接三种来源绘制边,节点颜色按 type 首次出现顺序从固定调色板分配。

适用场景:需要以纯文本、可移植方式组织知识库、数据目录、参考资料或操作手册,并希望同时供人和大模型读取时。

限制:编写前应先阅读 reference/SPEC.md(OKF v0.1 完整规范),规范与技能说明冲突时以规范为准;校验脚本会把断链报告为警告而非错误;渲染脚本依赖 CDN 加载 cytoscape 与 marked,无构建步骤。其他收费、平台等信息暂未提供。