open-knowledge-discovery
Read when the user asks what OpenKnowledge is, wants to install it on a repository, wants to open or preview a single markdown file that is not part of an OpenKnowledge project, wants to share an OpenKnowledge project with collaborators, or asks how `ok init` / `ok cowork` / OK Desktop set up a project. Do NOT load to perform OpenKnowledge reads/writes — the runtime guidance for editing markdown inside an initialized OK project ships as a separate project-local skill at `.claude/skills/open-know
Security Assessment
About open-knowledge-discovery
This skill provides discovery, installation, and file-opening guidance for OpenKnowledge (OK), a markdown-CRDT collaboration platform that turns a directory of .md/.mdx files into a live, multi-writer knowledge base where agents and humans edit the same documents in real time with attributed changes and a browser preview. It answers the questions of what OpenKnowledge is, how to install it on a repository, how to share a project with collaborators, and how to open or preview a single markdown file that is not part of a project.
It documents the one setup verb, ok init (run via npx @inkeep/open-knowledge or a global install), which scaffolds a .ok/ config directory, wires the OpenKnowledge MCP server into detected editors (Claude Code, Cursor, Codex), installs a project-local runtime skill under .claude/skills and .cursor/skills, and ensures a git repository exists. It explains sharing by committing those directories, the ok cowork command that builds an uploadable skill for Claude Desktop, the standalone OK Desktop macOS app, and a careful decision procedure for opening a loose file: use the preview_url MCP tool plus an in-app browser when one exists, otherwise ok open, and never run ok init merely to view a file. It deliberately excludes the in-project read/write runtime contract, which ships as a separate project-local skill.
It targets developers, technical writers, and teams adopting OpenKnowledge for collaborative documentation. As pure discovery and install guidance it requires no MCP server itself and is compatible with any agent host.
FAQ
What is OpenKnowledge?
A markdown-CRDT collaboration platform that turns a directory of .md/.mdx files into a live, multi-writer knowledge base with real-time, attributed edits and a browser preview.
How do I install it on a repository?
Run ok init from the repo root (npx @inkeep/open-knowledge init, or install globally and run ok init). It scaffolds .ok/, wires the MCP server into detected editors, installs the project-local runtime skill, and ensures a git repo.
Can I preview a markdown file without setting up a project?
Yes. A single file can open in a throwaway temp session with live preview; the skill stresses you should never run ok init just to view a file. Use the preview_url MCP tool with an in-app browser, or ok open on a pure-stdio CLI.
Does this skill handle editing files inside a project?
No. The read/write runtime contract ships separately as a project-local skill installed at .claude/skills/open-knowledge/ when ok init runs; if it is missing, the repo was never ok init'd or the skill directory was not committed.
Does it need an MCP server to run?
No. It is pure discovery and install guidance compatible with any agent host, though opening files via preview_url requires the OK MCP server to be wired in.
Install open-knowledge-discovery
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
inkeep/open-knowledge-skills