use the library
Load bundles, parse and round-trip concepts, walk the graph from C#. → library.md
These docs are an OKF bundle — one markdown concept per page, cross-linked and indexed. What follows is index.md: the generated listing okf index would write for this directory.
| Type | Concept | Description |
|---|---|---|
| Guide | getting-started | Install the library from NuGet and the okf CLI, then validate your first bundle. |
| Guide | guides | Task recipes: traverse the cross-link graph, gate CI on conformance, generate indexes (§6) and changelogs (§7), round-trip with fmt, publish the AOT binary. |
| Reference | library | The C# API surface — Bundle, ConceptId, OkfDocument, Frontmatter, the YAML subset, links, IndexGenerator, ChangeLog. |
| Reference | cli | The six okf commands — flags, exit codes, and copy-paste transcripts. |
| Reference | agentssoon | The Microsoft Agent Framework layer — nine bundle tools and a budget-bounded context provider. |
| Guide | mcp | Serve a bundle to Claude Desktop, Claude Code, and any MCP client with the okf-mcp server — install and connect, step by step. |
| Reference | spec | OKF v0.1, section by section, mapped to the types that implement it. |
The reference pages are landing one at a time. Until each does, the overview pages below cover the essentials.
Load bundles, parse and round-trip concepts, walk the graph from C#. → library.md
Validate, index, and graph bundles from one AOT binary — drops into CI. → cli.md
What a bundle is, the reserved files, and the one conformance rule. → what-okf-is.md
Expose a bundle to an AI agent as tools plus bounded context. → agents.md soon
Serve the bundle to Claude and any MCP client as read/write tools. → mcp.md
Guides are task-shaped — they walk you end to end through one job. Reference pages are lookup-shaped — one entry per type, command, or tool, exhaustive and skimmable. The sidebar is the bundle tree; every page is a concept you could cat.
→ okf4net.md — back to the overview