Skip to content

ryansann/okfview

Repository files navigation

OKFView

A configurable context bridge for your projects, docs, and coding agents, built on Open Knowledge Format.

CI Release License: Apache-2.0 OKF MCP Platform: macOS Built with: Electron + TypeScript

Demos

For humans

OKFView preview

Watch the full in-app demo

For agents

OKFView agent demo

Watch the full agent demo

What is OKFView?

OKF is Google Cloud's open standard for representing knowledge as a directory of Markdown files with YAML frontmatter.

OKFView turns OKF into a shared knowledge layer across all the places you work: local projects, documentation folders, reference bundles, and coding agent sessions. Open the knowledge once, scope what should be shared, and let humans and agents browse the same live context over a polished desktop UI and the Model Context Protocol.

Think of it as:

OKF >> skills

Skills are useful entry points, but OKF gives you a finer-grained web of documents: concepts, references, backlinks, process notes, conformance checks, and relationships that can be progressively disclosed instead of dumped into one long prompt or one giant directory. That makes it a better home for tacit project knowledge: how systems are shaped, why decisions were made, what workflows matter, and which references an agent should use before touching code.

Why it matters

  • Bridge every project - keep reusable knowledge in OKF bundles and open them wherever you need context.
  • Share context across agent sessions - expose selected bundles over MCP instead of re-explaining the same project history.
  • Progressively disclose knowledge - agents can list bundles, inspect tables of contents, read one concept, follow links, and search when needed.
  • Encode tacit process - capture decisions, workflows, review rules, domain notes, and references as linked documents, not scattered instructions.
  • Keep humans in the loop - browse, validate, and edit the same knowledge graph your agents consume.

Features

  • Document view - rendered Markdown with frontmatter, schema tables, citations, outgoing links, and backlinks.
  • Graph view - an interactive concept graph, colored by type, with click-to-navigate links.
  • Command palette - full-text search (Cmd+K / Ctrl+K) across every open bundle, including body text.
  • Local and remote sources - open a folder, git repo (...repo.git#subpath), or .tar.gz URL.
  • Live sync - file edits appear instantly without losing your place; remote sources poll for updates.
  • MCP server - expose scoped bundles to coding agents so they can browse, search, and validate OKF.
  • Diagnostics - embedded okftool validation surfaces spec conformance and lint feedback without blocking viewing.
  • Persistence - open bundles auto-restore; recent bundles and aliases are remembered.

okftool feedback loop

OKFView embeds okftool, the validator and linter for OKF bundles. The viewer stays permissive: non-conformant bundles still open, with issues shown as diagnostics. Agents can use the same okftool-backed MCP validation tools as a feedback loop while authoring, so they can generate bundles that are not just valid, but well structured for graph navigation and progressive disclosure. Strictness is configurable in Settings, and a bundle can define its own policy with .okftool.yml or .okftool.yaml at the bundle root.

Install (macOS)

Download the latest .dmg (arm64 or x64) from the Releases page and drag OKFView to Applications.

Public macOS releases are Developer ID signed and notarized. See Security for packaging details.

Other platforms can build from source.

Quick start

  1. Open a bundle - click Open folder... and pick an OKF directory (try this repo's own docs/okf/).

  2. Explore - read in the document view, switch to the graph, press Cmd+K / Ctrl+K to search.

  3. Connect an agent - in Settings > Agents (MCP), enable the server and share a bundle, then:

    claude mcp add --transport http okfview http://127.0.0.1:7331/mcp

Documentation

OKFView documents itself in the format it views: the docs are a native, conformant OKF bundle at docs/okf/; open it in the app to browse the architecture, features, reference, and design decisions as a graph.

Contributing

OKFView is open source and contributions are welcome; see CONTRIBUTING.md for dev setup, the repo layout, and the PR flow. Please also review the Code of Conduct, Security Policy, and Support guide.

License

Apache-2.0, matching the OKF ecosystem.

About

Open Knowledge Format (OKF) for Humans and Agents

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors