mcpField
O
open-knowledge-discovery

open-knowledge-discovery

github.com/inkeep生産性1415.1k 回インストール1 日前に更新
リポジトリ

open-knowledge-discovery について

OpenKnowledge の導入や Markdown ファイルのプレビューを行うエージェント向けの発見・起動スキルです。プロジェクト設定、MCP 接続、単一ファイルの一時プレビューを扱い、プロジェクト内の読み書き規則は対象外です。

主な機能

  1. 01OpenKnowledge プロジェクトの初期化
  2. 02MCP とプロジェクトスキルの接続
  3. 03プロジェクトや単一 Markdown ファイルを開く
  4. 04MCP 経由でプレビュー URL を取得

活用シーン

  1. 01リポジトリに OpenKnowledge を設定
  2. 02単独の Markdown ファイルをブラウザーでプレビュー

MCP 対応

`ok init` で検出されたコーディングエージェントに OpenKnowledge MCP サーバーを接続し、`preview_url` でファイルのプレビュー URL を取得する方法を説明します。

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/inkeep/open-knowledge-skills --skill open-knowledge-discovery

インストール後、Claude Code で/open-knowledge-discoveryを入力して読み込まれたか確認します。

詳細

OpenKnowledge — 概要とインストール方法

OpenKnowledge（OK）は、Markdown CRDT コラボレーションプラットフォームです。.md／.mdx ファイルのディレクトリを、複数の書き手がリアルタイムで共同編集できるナレッジベースに変えます。エージェントと人間が同じドキュメントをリアルタイムで編集し、変更にはすべて作成者が記録され、ブラウザーのプレビューには編集内容が反映されるたびに表示されます。

このスキルでは、OpenKnowledge ファイルの検出、インストール、開き方を扱います。プロジェクトに属さない単一ファイルを開く方法も含まれます（下記のプロジェクト外のファイルを開くを参照）。プロジェクト内での読み書きに関するランタイム契約（ネイティブファイルツールの使用を停止するルール、根拠の提示とリンクに関するルール、MCP ルーティングテーブル）は含まれません。これらは ok init でインストールされる、プロジェクトローカルの別のスキルで提供されます（下記のプロジェクト内での作業を参照）。

CLI 名。 以下のコマンドでは、Stable の ok（open-knowledge）を使用します。OpenKnowledge Beta のターミナルコマンドは ok-beta（open-knowledge-beta）で、~/.ok/ の代わりに ~/.ok-beta/ を使用します。

リポジトリに OpenKnowledge をインストールする

リポジトリのルートで ok init を実行します。

npx @inkeep/open-knowledge init
# or, after a global install:
npm install -g @inkeep/open-knowledge
ok init

ok init は、セットアップに使用する唯一のコマンドです。次の処理を行います。

  • .ok/ ディレクトリを作成します（プロジェクト設定。content.dir のデフォルトは . です）。
  • このマシン上で検出したコーディングエージェントに OpenKnowledge MCP サーバーを接続します。--no-mcp を指定するとスキップできます。
  • 検出した各エージェントのスキルディレクトリ（<agent-dir>/skills/open-knowledge/）にプロジェクトローカルのランタイムスキルをインストールします。これにより、このリポジトリで作業するエージェントが読み書きの完全な契約を利用できます。OK が書き込むのは、すでに存在するエージェントディレクトリのみです。ディレクトリを作成することはないため、使用していないエージェントには何も追加されません。エージェントが見つからない場合は、その旨が ok init に表示されます。
  • プロジェクトに .git/ があることを確認します。

インストール済み CLI のバージョンに合わせて接続設定とスキルを更新するには、いつでも ok init を再実行してください。

OpenKnowledge プロジェクトを共同作業者と共有する

OK プロジェクトは、リポジトリと一緒に共有できます。共有するには、次の手順を実行します。

  1. .ok/ ディレクトリと、ok init が作成したプロジェクトローカルの <agent-dir>/skills/open-knowledge/ ディレクトリを、.md コンテンツとともにコミットします。
  2. 共同作業者がリポジトリをクローンし、一度 ok init を実行します。これにより、そのマシンに MCP サーバーが登録され、プロジェクトスキルが更新されます。
  3. ok start でエディターとプレビューを起動するか、OK Desktop でプロジェクトを開きます。

2 人の書き手が同じコンテンツディレクトリを開くと、リアルタイムで共同作業できます。

ok cowork — Claude Chat と Cowork

ok init によるエディターの接続設定は、Claude Chat や Cowork には適用されません。これらは Claude Desktop App 内にある別のスキルリストを読み込みます。ok cowork を実行して openknowledge.skill を作成し、Claude Desktop を開いてアップロードします（Customize → Skills → + → Create skill → Upload skill）。

OK Desktop

OK Desktop は、スタンドアロンの macOS アプリ（@inkeep/open-knowledge-desktop）です。独自の CLI をバンドルしており、プロジェクトをエディターとプレビューのウィンドウとして開き、起動するたびにプロジェクトの MCP 接続設定とスキルを最新の状態に保ちます。リリースページから DMG をダウンロードしてください。

プロジェクト外のファイルを開く

OpenKnowledge は、OK プロジェクトに含まれない単独の Markdown ファイル（単独の .md / .mdx ファイル、または ok init を実行したことのない通常のリポジトリやフォルダー内にあるファイル）を開けます。使い捨てのセッション（OS の一時ディレクトリ内に一時プロジェクトを作成します。リポジトリには一切変更を加えず、その中に .ok/ も書き込みません）で開き、プロジェクト内と同じライブプレビューを表示します。

ファイルを表示したり開いたりするためだけに、ok init を実行してはいけません。 ok init はリポジトリを共有可能な OpenKnowledge プロジェクトにするもので、単一ファイルを開く前提条件ではありません。ファイルを開くのにプロジェクトや .ok/、起動済みのサーバーは必要ありません。以下のいずれの方法でも、セッションはその場で起動します。

このようなファイルを開いたりプレビューしたりするよう頼まれたら、実際に利用できる表示環境に応じて判断してください。ホスト名ではなく、使えるツールを確認します。実際にブラウザーが使える場合に限ってブラウザーを開き、ブラウザーのないホストではブラウザーのタブを開かないでください。

  • アプリ内ブラウザー／組み込みブラウザーがある場合（Claude Code Desktop の Browser ペイン、Cursor、Codex など）— これが既定の方法です。file に絶対パスを指定して preview_url MCP ツールを呼び出します（セッションを検出するか、必要に応じて起動し、完全な url を返します）。その後、すぐにアプリ内ブラウザーでその url を開いてください。「開く」とは、ブラウザーでそのページに移動することです。URL を表示するだけで終わらせてはいけません。OK Desktop アプリがインストールされている場合に、ブラウザーで表示する唯一の方法でもあります（ok open は OK Desktop アプリを優先します）。URL は preview_url からのみ取得してください。ok ps / ok status / ok start で探したり、ポート番号を推測したりしてはいけません。
  • アプリ内ブラウザーがない場合（純粋な stdio の CLI）— ok open /abs/path/to/file.md を実行します。OK Desktop アプリがインストールされていればそれを開き、そうでなければブラウザーを開き、セッションも起動します。ユーザーが求めていないブラウザーのタブを無理に開かないでください。この場合は ok open を既定の方法として使います。ok が PATH にない場合は、npx @inkeep/open-knowledge open /abs/path/to/file.md でも同じことができます。

OK MCP サーバーがこのホストに接続されていない場合、呼び出せる preview_url はありません。その場合は、上記の ok open を使ってください。ok mcp を自分で起動したり、ok ps からポートを取得したりして、preview_url の動作を手動で再現してはいけません。

絶対パスを指定してください。ok open は、そのパスに対して解決した絶対プロジェクトルートを表示します。また、解決したルートが別のプロジェクト内にある場合は、外側のプロジェクト名も表示します。どのプロジェクトが選ばれたかを推測せず、その行を確認してください。

プロジェクトを自分で指定するには、--project <dir> を渡します。指定位置はどこでも有効です。パスの前後を問わず、拡張子 .md の有無を問わず、--project <dir> または --project=<dir> と指定できます。指定を適用できない場合、コマンドは 0 以外で終了し、その理由を表示します。そのため、保存先を確認するために別のコマンドを実行したり、修正のためにサーバーを停止したりする必要はありません。

同じファイルを再度開くと、同じセッションが開きます。URL を組み立てたり推測したりせず、preview_url が返すものを使ってください。

OK でできるその他のこと

このスキルでは OK の機能をすべて列挙していません。また、機能はリリースごとに変わります。OK が何かに対応しているか尋ねられたら、推測せずに以下を確認してください。

プロジェクト内で作業する場合 — このスキルではなく、プロジェクト固有のスキルを使用してください

このスキルを使って OpenKnowledge の読み取りや書き込みを行わないでください。実行時の契約（対象範囲内の Markdown に対するネイティブなファイルツールの使用を禁じる STOP ルール、プレビュー接続のハンドシェイク、根拠付けとリンクのルール、MCP ツールのルーティング表）は、検出された各エージェントのスキルディレクトリ（<agent-dir>/skills/open-knowledge/SKILL.md）にインストールされる別のプロジェクト固有スキルに記載されています。このスキルは ok init の実行時にインストールされます。

ユーザーが .ok/ ディレクトリのあるプロジェクト内の Markdown を編集していて、この検出用スキルだけが OpenKnowledge のスキルとして読み込まれている場合、プロジェクト固有のスキルがありません（リポジトリで ok init が一度も実行されていないか、スキルディレクトリがコミットされていません）。インストールするために ok init を実行するよう、ユーザーに案内してください。

詳細を見る

  • コマンド一覧をすべて確認するには、ok --help を実行してください。

コメント

Markdown 対応