Unofficial OKF guide

Open Knowledge Format guide for OKF bundles

Open Knowledge Format uses Markdown files and YAML frontmatter to package AI-agent-readable knowledge. This unofficial guide helps you validate one OKF file, check a folder bundle, copy templates, and study practical examples.

Validate one OKF file Validate a folder Bundle checklist

bundle/

index.md

pages/home.md

api/create-customer.md

--- type: Website Page title: OKF Validator tags: [okf, markdown] ---

What is OKF

Plain Markdown, small metadata, portable knowledge

Open Knowledge Format is useful when knowledge needs to stay readable by humans while also being easier for AI agents to scan, route, and retrieve.

Format

OKF uses plain Markdown files with YAML frontmatter so knowledge can stay readable without a special runtime.

Bundle

A folder of OKF documents can be shipped through Git, a zip archive, or any static file host.

Agent input

AI agents can scan titles, descriptions, tags, resources, links, and body sections before loading deeper context.

Why OKF matters

It makes source knowledge easier to inspect before an agent uses it

Without structure, a knowledge folder becomes another pile of text. OKF adds just enough metadata to identify what each file is, what it describes, where it came from, and how it connects to related concepts.

Useful for website pages, API endpoints, support workflows, documentation topics, and data assets.
Works with Git, static hosting, editors, search indexes, and retrieval systems.
Stays readable because the body is still normal Markdown.

How OKF works

Write one concept per file, then connect files with normal links

The frontmatter gives compact structured data. The Markdown body carries the explanation, examples, tables, citations, and links.

OKF minimum example

---
type: Website Page
title: Open Knowledge Format Validator
description: A browser-only tool that checks basic OKF frontmatter fields.
resource: https://openknowledgeformat.online/okf-validator/
tags: [okf, validator, markdown]
timestamp: 2026-06-21T00:00:00Z
---

# Purpose

This page helps users test whether a Markdown document includes the fields expected by this guide.

Single-file validator

Paste Markdown and check whether the guide profile fields are present. The check runs in your browser.

Try OKF Validator

Folder validator

Select a local OKF folder and check frontmatter, duplicate resources, index coverage, and relative Markdown links.

Check OKF Folder

Error guide

Fix missing frontmatter, missing type, invalid tags, broken links, and bundle-level warnings before publishing.

Fix OKF Errors

Conversion paths

Create OKF from websites and APIs

These guides help you draft OKF files from existing source material without treating generated drafts as verified truth.

Website to OKF

Map important URLs to one Markdown concept file each, then validate the bundle before publishing.

Create website OKF

OpenAPI to OKF

Keep OpenAPI as the API contract and use OKF for endpoint context, owner notes, examples, and warnings.

Convert OpenAPI context

Templates and examples

Copy starter files and compare bundle shapes before expanding a generated draft.

Open OKF templates

Comparisons

OKF works beside nearby AI concepts

OKF vs MCP

MCP connects tools. OKF organizes knowledge. They can be used together.

Read comparison

OKF vs RAG

RAG retrieves context. OKF can make the source corpus cleaner before retrieval.

Read comparison

OKF vs llms.txt

llms.txt points to resources. OKF packages deeper structured knowledge.

Read comparison

OKF vs OpenAPI

OpenAPI describes API contracts. OKF adds surrounding knowledge context.

Read comparison

Sources and evidence

Use official sources for OKF facts and this site for practical guidance

OKF is described in public Google Cloud and GoogleCloudPlatform draft materials. This site is unofficial, so examples and workflow advice are guidance, not certification or a Google endorsement.

Resource center

Move from OKF basics to implementation paths

Use these clusters when you already know what OKF is and need a use case, a detail template, or a step-by-step guide.

Use cases

Start with websites, API docs, SaaS, data warehouses, AI agents, SEO, or AI search.

Explore use cases

Template details

Open a dedicated template page with fit guidance, examples, errors, and validator steps.

Open template details

How-to guides

Follow practical guides for bundles, frontmatter, links, RAG, MCP, and validation errors.

Read how-to guides

FAQ

Open Knowledge Format questions

Is this an official OKF website?

No. This is an unofficial guide and is not affiliated with Google.

Does the validator upload my Markdown?

No. The validator runs in your browser for this MVP and does not upload pasted content to this site.

Is OKF a replacement for MCP or RAG?

No. OKF organizes knowledge. MCP connects tools and resources. RAG retrieves context for model answers.

What should I create first?

Start with one small bundle that covers important public pages, core API endpoints, or one support workflow.