OKFy は何をしますか?
概要
OKFyを使用すると、ドキュメントWebサイトやローカルMarkdownフォルダをローカルのOpen Knowledge Formatバンドルに変換し、読み取り専用のMCPサーバーを通じてエージェントに公開できます。生成されるコマンドではnpx -y okfy-aiを推奨します。これにより、クライアントはグローバルインストールなしで公開パッケージを起動できます。
クイックリファレンス
| 目標 | コマンドまたはアクション |
|---|---|
| ドキュメントサイトを登録し、セットアップを出力 | npx -y okfy-ai init <name> <url> --client codex --max-pages 100 --max-depth 4 |
| ローカルMarkdownをインポート | npx -y okfy-ai import ./docs --out ./docs-okf --source-name "Project docs" |
| タスクのソースを証明 | npx -y okfy-ai activate <name-or-bundle> --client codex --task "<task>" --out okfy-activation |
| 準備状況とグラフをプレビュー | npx -y okfy-ai map <name-or-bundle> --out okfy-inspector.html |
| セットアップを診断 | npx -y okfy-ai doctor <name> --client codex |
| MCPにサーブ | npx -y okfy-ai serve <name-or-bundle> --mcp --auto-refresh |
セットアップワークフロー
stripe、clerk、project-docsのような短いソース名を選択します。- ドキュメントWebサイトの場合、
npx -y okfy-ai init <name> <url> --client codex --max-pages 100 --max-depth 4を実行します。 - ローカルMarkdownの場合、
import、次にvalidateを実行し、生成されたバンドルパスをサーブします。--forceは、ユーザーが出力ディレクトリの上書きを明示的に承認した場合のみ追加します。 - 設定変更前にユーザーが証明を求める場合、実際の質問に一致する
--taskを指定してactivateを実行します。パケットにはokfy-inspector.html、okfy-setup.md、okfy-proof.jsonが含まれます。 - セットアップが失敗した場合、またはMCPクライアントがツールを認識できない場合、クライアント設定を手動で編集する前に
doctorを実行します。
MCPの使用
OKFy MCPサーバーが利用可能な場合、次の順序でツールを使用します:
bundle_summaryで検証ステータス、鮮度、利用可能なソース、およびツールの期待値を検査します。search_conceptsをユーザーのタスク用語で使用します。関連するドキュメントソースがわかっている場合は、複数ソースのワークスペースでsourceフィルターを使用します。read_conceptで最も関連性の高い概念を読み取ります。読み取りは小さく保ち、その後拡張します。get_neighborsは、回答がリンクされた概念、バックリンク、前提条件、または近くのAPI/リファレンスページに依存する場合に使用します。- 概念結果で示されたソースURLまたはリソースフィールドを引用します。
最初は狭い検索から始め、結果が少ない場合のみ範囲を広げます。ワークスペースでは、概念IDが曖昧な場合にread_conceptにsourceとidの両方を渡します。
ワークスペース
タスクがスタック全体にわたる場合、1つのMCPサーバーで複数の登録済みソースをサーブします:
npx -y okfy-ai serve stripe clerk --mcp --auto-refresh
その後、検索をフィルタリングします:
{ "query": "checkout sessions", "source": "stripe", "limit": 5 }
ユーザーが製品、API、フレームワーク、またはドキュメントソースを指定した場合は、sourceフィルターを使用します。ユーザーがスタック全体について質問する場合は、最初にフィルターなしでワークスペースを検索し、次にソースごとの読み取りで精度を高めます。
安全ルール
- MCPツールは読み取り専用です。自動リフレッシュは、登録済みソースに対するサーバー側のメンテナンスであり、エージェントが呼び出し可能な書き込みツールではありません。
npx okfyは使用しないでください。インストール不要のコマンドにはnpx -y okfy-aiを使用します。serve --mcpを通常のチャットターミナルセッションとして実行しないでください。MCPクライアントはこれをstdioサブプロセスとして起動します。- クローラーの安全デフォルト、プライベートネットワーク保護、または安全でない
--forceガードをバイパスしないでください。ユーザーがリスクを明示的に受け入れた場合を除きます。 init、activate、またはdoctorで正確なコマンド/設定を生成または検証できる場合は、最初にクライアント設定を手動で編集しないでください。
よくある間違い
| 間違い | 修正方法 |
|---|---|
| OKFyをホスト型インデックスとして扱う | ワークフローをローカルに保つ: バンドルファイル、MCP stdio、ソースURLは検査可能なままです。 |
| 検索後にすべての概念を読む | 最初に上位の一致を読み、必要な場合のみneighborsを使用して展開します。 |
| ワークスペースのソース名を無視する | 複数ソースバンドルではsourceフィルターとソース修飾読み取りを使用します。 |
| 証明をスキップする | MCPを配線する前にユーザーが確信を必要とする場合、activate --taskを使用します。 |
| 設定を盲目的にデバッグする | doctor <name> --client codexを実行し、その次の修復コマンドに従います。 |