OKF: project knowledge beside your code

Keep rules, decisions, and instructions in Markdown so your team and AI agents can find an answer and open its source.

For example, a service retries failed delivery for 24 hours, then involves an operator. Record the rule, link it to the requirements, and let an agent find the answer. When the deadline changes, update the source and the note in the same workflow.

Open the training example · Try it locally

When it helps

• Before changing a service: find a constraint and inspect its source.
• When handing over a project: explain a decision together with the material behind it.
• After requirements change: find and review the affected notes.

What OKF includes

Open Knowledge Format describes Markdown files with metadata and links to sources. A knowledge bundle is a folder of these files with a root index.md.

This repository provides Go libraries, the okf command, an okf-mcp server, agent instructions, and an offline HTML viewer. Start with files and viewing, then connect an agent.

What to check yourself

OKF validation finds structural and link errors. Compare content with its source: the presence of sources does not mean a claim was checked. Add verified only after a real check. Document version 0.2 and program release version are separate values.

Next step

1. Create and find your first rule.
2. Install an agent skill and connect MCP.
3. Work with files and commands.
4. Review knowledge after changes.

Exact fields, limits, and interfaces are in the reference. The architecture example for this repository remains available separately in English.