okfshare CLI と MCP サーバー

okfshare のクライアントサイドを担うオープンソース実装です。AI コーディングエージェント向けに、共有・バージョン管理されたナレッジを提供します。

検証済みの Markdown バンドルを一度公開するだけで、承認されたすべてのエージェントが同じ不変のリビジョンを基準に、監査可能な行レベルの引用を利用して作業できます。ホスト型サービスはリビジョン、引用、ワークスペース認証を保持し、このリポジトリにはエージェントが実際に実行するツールが含まれています。

パッケージ

Related MCP server: JacBrain

クイックスタート

# 1. One-time onboarding (device pairing in your browser)
npx okfshare@latest setup

# 2. Validate and publish a folder of Markdown
npx okfshare@latest validate ./knowledge
npx okfshare@latest publish ./knowledge --visibility public --yes

# 3. Any teammate's agent retrieves cited context
npx okfshare@latest context SHARE_ID "how do we handle db migrations"

ヘッドレス / CI 環境では、事前にプロビジョニングされた認証情報を OKFSHARE_TOKEN 環境変数で指定します（存在確認のみ行い、絶対にログ出力しないこと）。その後、whoami と doctor で検証します。

MCP セットアップ

claude mcp add okfshare -- npx @okfshare/mcp@latest

または、任意の MCP クライアント:

{
  "mcpServers": {
    "okfshare": {
      "command": "npx",
      "args": ["@okfshare/mcp@latest"]
    }
  }
}

ツール: whoami、doctor、list_shares、search_share、search_workspace、get_context、pull_bundle、publish_bundle。レジストリマニフェスト: server.json。

引用がなぜ重要な理由

取得結果は、ファイル、正確な行、そしてそれらの出典となる不変のリビジョンを返します。エージェントが「当社の規約は X」と主張した場合、その主張を数秒で監査できます。リビジョンの内容はその場で変更されることがないため、引用は明日も同じ意味を持ち続けます。

Open Knowledge Format

バンドルは構造化されたフロントマターを持つ Markdown です: type、タイトル、説明、タグ、ソース、検証イベントを含みます。この形式は意図的に小さく保たれており、どのエディタでも読みやすいままです。最悪の場合でも、残るのはプレーンファイルだけです。ロックインはありません。

• 仕様: https://github.com/GoogleCloudPlatform/knowledge-catalog/blob/main/okf/SPEC.md

• フィールドガイド（okfshare 自身が公開しています）: https://okfshare.app/s/ecf08367a22273482c0887ca8700ee8e

• フォーク可能な規約スターター: https://okfshare.app/s/e8ddeda5aab619495c970f031dce7058

開発

pnpm install
pnpm check   # typecheck + test + build across all packages

• Node.js 20+ と pnpm 10。

• 各パッケージは、ホスト型 API である https://okfshare.app に接続します。ローカルサーバーは開発には不要です。

• 受け入れフローは CONTRIBUTING.md を、脆弱性の報告は SECURITY.md を参照してください。

リンク

• サイトとドキュメント: https://okfshare.app

• エージェント向けドキュメント: https://okfshare.app/llms.txt および https://okfshare.app/llms-full.txt

ライセンス

Apache-2.0 ライセンスです。NOTICE もご覧ください。コードのライセンスは okfshare の名称やブランドに対する権利を付与するものではありません。