Skip to content

okf-tools

Tools to query and consume Open Knowledge Format (OKF) data catalogs — usable as plain standalone Python functions, or wired into AI agent frameworks (LangChain, PydanticAI, Google ADK).

What is OKF?

OKF represents a data catalog ("bundle") as a directory tree of markdown files with YAML frontmatter: each file (a "concept") describes a table, metric, playbook, or any other unit of knowledge, and concepts link to each other via ordinary markdown links — the bundle is graph-shaped, not just a tree. See the OKF v0.2 spec for the full format.

okf-tools parses bundles (tolerating malformed or partial data — a philosophy the format itself encourages), builds a lightweight graph of the links between concepts, and exposes a small set of query functions: list bundles, fetch a concept, search by keyword, expand a concept's neighborhood, browse a directory listing, and pull a named section out of a concept's body. The same functions work standalone or as tools handed to an agent.

Install

The base package has no agent-framework dependencies — add only the framework(s) you use. The PyPI distribution is named okf-agent-tools (okf-tools was taken by an unrelated, similarly-named project), but the importable module stays okf_tools:

pip install okf-agent-tools                 # standalone use only
pip install okf-agent-tools[langchain]      # + LangChain tools
pip install okf-agent-tools[pydantic-ai]    # + PydanticAI tools
pip install okf-agent-tools[adk]            # + Google ADK tools

To track main instead of the latest PyPI release:

pip install git+https://github.com/armandokeller/okf-tools

See Quickstart to get started, or the API Reference for the full function-by-function documentation.