
okf-knowledge-base
Open Knowledge Format (OKF) v0.2 guidance. Use when creating, reading, reviewing, or maintaining an OKF bundle; responding to OpenKnowledge okf plugin warnings; or choosing types, provenance, links, indexes, or logs.
- Installs
- 9.3K
- Last 24h
- —
- Trending rank
- —
- Security
- Pass
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/inkeep/open-knowledge-skills --skill okf-knowledge-base- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads okf-knowledge-base automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
Security audits
Independent scans of the skill's instructions and bundled files.
SKILL.md
The instructions your agent reads when the skill is triggered.
Open Knowledge Format (OKF)
OKF v0.2 is a portable format for agent-readable knowledge: Markdown files, YAML frontmatter, and standard links. The /open-knowledge skill governs tool use; this skill covers OKF semantics.
Core rules
- A bundle is a directory tree of
.mdfiles. Each non-reserved file is one concept; its path without.mdis its ID. - Every concept needs parseable frontmatter with a non-empty string
type. No other field is always required. - Types are an open vocabulary. Consumers must accept unfamiliar types and metadata.
- Use standard Markdown links for portable relationships. Broken links and a missing index are allowed.
index.mdandlog.mdare reserved at every level. Use lowercase filenames.- An
index.mdnormally has no frontmatter; only the root index may declareokf_version: "0.2". - A
log.mdis newest-first; entry headings begin with an ISO date —## YYYY-MM-DD: Summary(the summary after the date is optional; a bare## YYYY-MM-DDis equally conformant). - OKF consumers read
.md, not.mdx.
Authoring judgment
- Make each concept the smallest useful link or citation target. Choose a stable, descriptive type;
Documentis only a generic fallback. - Do not invent facts, relationships, resources, sources, verification, or history. Missing knowledge is better than false structure.
- Use
title,description,resource, andtagsonly when they add real information. - Record provenance in
sources. Join claim-level citations with matchingsources[].idand Markdown footnotes. - Keep authorship and verification separate:
generatedsays who produced content;verifiedsays who confirmed it. Use exact lowercasehuman:andprocess:prefixes when applicable. - Write every provenance timestamp as an ISO 8601 datetime with an explicit UTC offset (
stale_after: 2026-12-31T00:00:00Z), never a bare date and never an offsetless time. This coversgenerated.at,verified[].at,stale_after,sources[].last_modified, and bothusage_windowbounds. Alog.mdentry heading is different: it stays a plainYYYY-MM-DDdate. - Treat
status: deprecatedand expiredstale_aftervalues as trust signals, not validation errors. - For
type: Attested Computation, follow the declared runtime and parameters. Do not rewrite the sanctioned computation.
Read and maintain a bundle
- Start with the nearest
index.md, inspect frontmatter, then follow only relevant links. - Prefer current, verified sources, but tolerate unknown types and incomplete links.
- If the bundle conflicts with an assumption, trust the bundle; if it is missing or inconsistent, say so.
- Write durable discoveries back to the relevant concept and authored enumerations.
- Add a truthful dated
log.mdentry after durable changes when the bundle uses a log. - Read legacy
timestampand body citations, but prefer v0.2generated.atandsourceswhen updating a concept. Never invent provenance while migrating.
OpenKnowledge's okf plugin
The optional project plugin provides continuous portability feedback without blocking writes:
- Write-time warnings and project audits check structure, frontmatter, reserved files, links, and
.mdxuse. .ok/okf/*.schema.jsoncontains the precise field contracts. Read these generated files instead of guessing; do not edit them.- Deterministic lint findings establish conformance. Agent judgment still establishes whether metadata is true and useful.
- Optional index generation maintains
index.mdfiles. Generated indexes are machine-owned: never edit them, because OpenKnowledge replaces their contents. log.mdremains authored, not generated.
The plugin is off by default and each rule can be disabled. Its value is early warning when OpenKnowledge-native content would be misread by another OKF consumer.
FAQ
What does the okf-knowledge-base skill do?
Open Knowledge Format (OKF) v0.2 guidance. Use when creating, reading, reviewing, or maintaining an OKF bundle; responding to OpenKnowledge okf plugin warnings; or choosing types, provenance, links, indexes, or logs.
How do I install okf-knowledge-base?
Run npx skills add https://github.com/inkeep/open-knowledge-skills --skill okf-knowledge-base in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/okf-knowledge-base/ (personal) or .claude/skills/okf-knowledge-base/ (project).
Which AI agents can use okf-knowledge-base?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is okf-knowledge-base safe to install?
Security partners have reviewed it: Gen Agent Trust Hub passed; Socket passed; Snyk passed. As with any skill, read the SKILL.md and bundled scripts before installing.
Who maintains okf-knowledge-base?
It is published by inkeep in inkeep/open-knowledge-skills. It has 9,256 recorded installs.
More from inkeep/open-knowledge-skills
open-knowledge-discovery
inkeep/open-knowledge-skills
Read when the user asks what OpenKnowledge is, wants to install it on a repository, wants to open or preview a single markdown file that is not part of an OpenKnowledge project, wants to share an OpenKnowledge project with collaborators, asks whether OpenKnowledge supports a particular capability, or asks how ok init / ok cowork / OK Desktop set up a project. Do NOT load to perform OpenKnowledge reads/writes — the runtime guidance for editing markdown inside an initialized OK project ships as a separate project-local skill installed into each detected agent's skills dir (for example .claude/skills/open-knowledge/) whenever ok init runs.
open-knowledge-write-skill
inkeep/open-knowledge-skills
Use when the user wants to create, author, write, or design a new Agent Skill (a SKILL.md) — for OpenKnowledge or for their editors — including requests like 'help me write a skill', 'make a skill that…', 'turn this workflow into a skill', or improving an existing skill's triggering and discipline. Also use when capturing reusable agent guidance that should live as an installable skill rather than a one-off prompt. Covers choosing scope (project vs global), authoring inside a plugin or skills-distribution repo (write in the repo's own layout, never install), the SKILL.md frontmatter contract, progressive-disclosure structure, evaluating the skill, and installing it into the user's editors.
open-knowledge
inkeep/open-knowledge-skills
Authoritative agent-runtime contract for working inside an OpenKnowledge project — a markdown-CRDT knowledge base exposed over MCP. Use whenever reading, listing, searching, editing, or linting any .md or .mdx file in the project, and before any mcpopen-knowledge tool call (exec, search, write, edit, lint, and the rest). Installed by ok init, so its presence means this is an OpenKnowledge project and it governs every markdown file here. Covers the read/write tool surface, grounding and linking rules, folder/template conventions, the live browser preview, and the rule that OK's MCP tools — never native file tools — handle in-scope markdown.
knowledge-base
inkeep/open-knowledge-skills
How to work in a Knowledge Base project (the knowledge-base starter pack). Read when the project has the three-layer source-grounded layout — external-sources/ → research/ → articles/ — or when asked how this project is organized. Carries the layer model, per-folder rules, status flows, and log discipline so this guidance does NOT live inside template bodies or log.md. The three procedures live elsewhere: ingest in the platform open-knowledge skill, research and consolidate as their own sibling skills in this pack. Complements the platform open-knowledge skill; does not replace it.
research-with-sources
inkeep/open-knowledge-skills
Investigate a topic against preserved sources and write a draft-status research article under research/ in a Knowledge Base project (the knowledge-base starter pack). Read when asked to research a topic, compare options, synthesize sources, gather evidence, or extend an existing research doc. Carries the full procedure: scan existing coverage, agree a research rubric, capture every source verbatim before analyzing, write the article incrementally so a crash never loses work, cite every claim, and link it back into the graph. Does not promote findings to canonical knowledge — that is the sibling consolidate-notes skill, after a decision lands.
consolidate-notes
inkeep/open-knowledge-skills
Promote existing research into a stable-status canonical article under articles/ in a Knowledge Base project (the knowledge-base starter pack). Read when a decision has actually been made and the team wants the source-of-truth written down, or when asked to consolidate, canonicalize, promote research, or supersede an older article. Carries the decision-confirmation gate, the supersedes: chain that keeps the evidence trail intact, and the canonical voice. Does not conduct new research — that is the sibling research-with-sources skill.
Popular other skills
hyperframes-cli
heygen-com/hyperframes
The HyperFrames CLI by job - scaffold, check, look at frames, edit the timeline, preview, render locally or in the cloud, publish, project history - plus reading its JSON and recovering from build or render failures.
triage
mattpocock/skills
Move issues and external PRs through a state machine of triage roles, categorise, verify, grill if needed, and write agent-ready briefs.
ask-matt
mattpocock/skills
Ask which skill or flow fits your situation. A router over the skills in this repo.
to-questionnaire
mattpocock/skills
Turn a decision you can't fully answer into a questionnaire for someone else to fill in.
loop-me
mattpocock/skills
Grill me about specs for the workflows I want to build, within this workspace.