open-knowledge

What it does

Guides an agent to work inside an OpenKnowledge project, ensuring all reads and writes to Markdown files go through the MCP-based tools, honoring frontmatter, templates, grounding, and linking rules, and applying project-wide conventions for markdown collaboration.

How it works

• Recommends using MCP tools for reads: exec("cat …") for a document, exec("ls -A …") for a directory, exec("grep …") for a literal, and search for ranked retrieval; native reads on Markdown are discouraged.
• For writes: use write({ document: { path, content } }) for create/replace, edit({ document: { path, find, replace } }) for body find/replace, and edit({ document: { path, frontmatter } }) for frontmatter patches. Other operations include delete, move, and other write-related actions with their exact shapes; a one-line summary ≤80 chars is required on content writes.
• Encourages using the preview surface first (desktop terminal/in-app browser) to preview, and titles the operation accordingly. The one-surface rule is: determine your surface and then use ok open <name> or preview_url as appropriate.
• Emphasizes grounding: every factual claim must cite a local source, with ingest and citation practices described in references. Changes should be persisted incrementally to the knowledge base.
• Requires routing in-scope markdown through MCP tools and forbids native file tools on Markdown paths when OpenKnowledge MCP is configured.

When to use it

Use whenever reading, listing, searching, editing, or linting any .md or .mdx file in the project, and before any mcp__open-knowledge__* tool call (e.g., exec, search, write, edit, lint, and the rest). Also applied at project setup to confirm OpenKnowledge governance and tool surface rules.

What it can touch

• Tools: claude-code, codex (as declared). Requires OpenKnowledge MCP server + code execution. It governs read/write surface, grounding, and live preview rules for Markdown in this project.

Caveats

• Requires the OpenKnowledge MCP server and code execution environment. If MCP tools aren’t available, setup guidance in references must be followed. Theskill operates as the single source of OK agent guidance and enforces depth via references/*.md.