# Open Knowledge

Authoritative agent-runtime contract for working inside an OpenKnowledge project, a...

- Repository: https://github.com/inkeep/open-knowledge (4756 stars)
- Category: AI and agents
- License: GPL-3.0
- Last updated: 2026-10-31
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add inkeep/open-knowledge --skill open-knowledge -g -a claude-code -y`
Codex: `npx skills add inkeep/open-knowledge --skill open-knowledge -g -a codex -y`
Cursor: `npx skills add inkeep/open-knowledge --skill open-knowledge -g -a cursor -y`
Gemini CLI: `npx skills add inkeep/open-knowledge --skill open-knowledge -g -a gemini-cli -y`

## Description

Authoritative agent-runtime contract for working inside an OpenKnowledge project, a markdown-CRDT knowledge base exposed over MCP. Use whenever reading, listing, searching, editing, or linting any `.md` or `.mdx` file in the project, and before any `mcp__open-knowledge*` tool call (`exec`, `search`, `write`, `edit`, `lint`, and the rest). Installed by `ok init`, so its presence means this is an OpenKnowledge project and it governs every markdown file here. Covers the read/write tool surface, grounding and linking rules, folder/template conventions, the live browser preview, and the rule that OK's MCP tools, never native file tools, handle in-scope markdown.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# OpenKnowledge, agent guidance

OpenKnowledge (OK) is a markdown-CRDT collaboration platform exposed via MCP. This skill is the single source of OK agent guidance. Every rule below is a MUST unless marked otherwise. **Depth lives in `references/*.md`, one level deep; load a reference when its task comes up.**

> Skill version tracks `@inkeep/open-knowledge-server`. `cat ~/.ok/skill-state.yml` shows what's installed. `ok seed` needs `@inkeep/open-knowledge` >= 0.4.0; if it errors `unknown command`, `npm install -g @inkeep/open-knowledge`.

> **CLI name.** Commands here use Stable's `ok` (`open-knowledge`) and `~/.ok/`. With OpenKnowledge Beta, use `ok-beta` (`open-knowledge-beta`) and `~/.ok-beta/` instead; `preview_url`'s `okOpenCommand` already names the right one.

> **Setup (not connected yet?).** If the `mcp__open-knowledge*` tools aren't available in your client, this project isn't wired up on this machine, see [`references/setup.md`](references/setup.md) for the rung ladder (approve `.mcp.json` → `ok start` CLI → optional desktop app) and the canonical quickstart.

## TL;DR, the 90% case

The rest: https://github.com/inkeep/open-knowledge/blob/HEAD/packages/server/assets/skills/project/SKILL.md