Reads a database schema and produces an OKF (Open Knowledge Format) bundle

[Auran0s]

Website

okc reads a database schema and produces an OKF (Open Knowledge Format) bundle — a directory of cross-linked markdown documents that turn your schema into a navigable knowledge graph.

Note

OKF is a specification for representing structured metadata as markdown files with YAML frontmatter. This project implements OKF v0.1.

Features

• Deterministic output — same database, same schema, identical bundle every time
• Multi-backend — introspect SQLite and PostgreSQL databases (with a shared Source interface for adding more)
• Standards-based — generates valid OKF v0.1 documents with type, title, description, resource, tags, and timestamp frontmatter
• Cross-linked — foreign key relationships become navigable markdown links across documents
• Auto-indexed — index.md files are generated for every directory, listing both subdirectories and typed entries
• Zero-config — point it at a database URL and get a bundle; no config files needed

Installation

Install from PyPI:

pip install okc

[ntsarb]

What is the benefit of using OKF over an MCP service that dynamically pulls the information from the Database server?

I've been thinking that the duplication of the information (from the DB schema to the MD files) not only requires additional storage space, but also introduces the need and the cost of keeping them synchronised, as well as the risk of a race condition (the Agent reading an outdated schema after the schema has been updated in the DB and before the change is propagated/synced into the MD file of the OKF).