Skip to main content
Glama

KnownPath

KnownPath は、AI コーディングエージェント向けのオープンソースの共有ナレッジネットワークです。長期的な目的は、検証済みで再利用可能なエンジニアリング経験をエージェントネイティブなインターフェースで利用できるようにすることで、エージェントが同じ技術的解決策を繰り返し再発見するのを防ぐことです。

[!IMPORTANT] KnownPath は現在、段階的に積極開発中です。Phase 13 では、ポータブルなインストーラー CLI と、5 つのコーディングエージェント向けの安全なアダプターが追加されます。コントリビューション/アウトカムツール、ダッシュボード、パブリックサインアップ、パブリック匿名アクセスはまだ実装されていません。インストーラーは knownpath として公開されています。

前提条件

  • Node.js 24 LTS(。nvmrc はサポート対象のメジャーバージョンを追跡し、package.json はテスト済みのバージョン範囲を強制します)

  • Corepack(サポート対象の Node.js ディストリビューションに同梱)

  • ローカル MongoDB 用の Compose 対応 Docker Desktop またはその他の Docker Engine

Related MCP server: Cortex

インストール

corepack enable
pnpm install
cp .env.example .env

.env.example の説明に従って、独立した BETTER_AUTH_SECRET と API_KEY_PEPPER の値を生成します。コミット済みの例には、デフォルトの認証情報は含まれていません。

現在の開発環境を起動する

MongoDB を起動します:

pnpm dev:infra

現在のコレクション、バリデータ、インデックスを作成または調整します:

pnpm db:init

オプションの永続性確認と、リポジトリ層のラウンドトリップ検証:

pnpm db:inspect
pnpm db:verify

マスクされた CLI を通じて最初のローカルユーザーまたは管理者を作成します(登録は終了しています):

pnpm auth:user:create

必要に応じて .env に GITHUB_TOKEN を設定すると、通常の 5,000 リクエストの認証付き REST レート制限と GitHub Discussions へのアクセスが有効になります。その後、制限付きコレクションをプレビューまたは実行します:

pnpm ingest:github --source expo-core --types issues --limit 5 --dry-run
pnpm ingest:github --source expo-core --types issues --limit 5

バックフィルを実行する前に、GitHub 取り込みガイド を参照してください。

ソースレコードを書き込まずに、現在キュレーションされた公式ドキュメント群を発見し、制限付きソースまたは 1 つのインデックス付きページを同期します:

pnpm ingest:sources discover --source expo-documentation --limit 20
pnpm ingest:sources sync --source expo-documentation --limit 5 --dry-run
pnpm ingest:sources sync --source expo-documentation \
  --page https://docs.expo.dev/workflow/upgrading-expo-sdk-walkthrough --limit 1

キュレーションを変更したり、制限付きのフルカタログ実行を要求したりする前に、公式ソース取り込みガイド を参照してください。

無視される .env 内の Gemini 開発キーを使って、制限付きの公開ソース候補を処理または検査します:

pnpm extract one --source-item <uuid>
pnpm extract pending --limit 5
pnpm extract inspect --attempt <uuid>
pnpm extract inspect --candidate <uuid>

無料の Gemini パスは、プロバイダー呼び出しの前に、プライベート/チームのソースレコードをハード拒否します。キーを設定したりバッチを拡張したりする前に、AI 抽出ガイド を読んでください。

AI プロバイダーを呼び出さずに抽出された候補をスコアリングし、完全な内訳/履歴を調べます:

pnpm score one --candidate <uuid>
pnpm score pending --limit 10
pnpm score inspect --assessment <uuid>
pnpm score history --candidate <uuid>

スコアは説明可能なランキングシグナルであり、真実の確率ではありません。バージョン管理されたポリシーを変更する前に、スコアリングガイド を読んでください。

不変の類似性プロファイルを構築し、ブロックされたペアを発見し、レビューを検査し、決定論的に安全な正規化マージのみを適用します:

pnpm canonicalize profile --limit 10
pnpm canonicalize discover --limit 10
pnpm canonicalize review --limit 20
pnpm canonicalize auto-merge --limit 10       # dry-run
pnpm canonicalize auto-merge --limit 10 --apply
pnpm canonicalize history --known-path <uuid>

Gemini 埋め込みは、候補と参照されたすべてのソースの両方が公開されていると検証された後にのみ生成されます。それらは、もっともらしいブロック済み比較をサポートしますが、自動マージを決定することはありません。マージや手動操作を適用する前に、正規化ガイド を読んでください。

現在の正規化済み検索投影を作成し、ローカルでクエリします。明示的に要求されない限り、レビュー状態のレコードは除外されます:

pnpm run search project --pending --limit 10
pnpm run search query --text "EAS build cannot find an imported file" \
  --error "None of these files exist" --ecosystem expo --include-review
pnpm run search indexes print

ローカル MongoDB は完全一致/エラー許容検索と重み付きテキスト検索を使用し、セマンティック検索が利用できないことを明確に報告します。Atlas というSearch/Vector Search はオープンな設定です。無料の Gemini プロバイダーは、プライベート/チームのドキュメントとクエリ文をハード拒否します。Atlas を有効にしたり、ランキング/モデル設定を変更したりする前に、検索ガイド を読んでください。

すべてのアプリケーションとパッケージの開発プロセスを起動します:

pnpm dev

現在の Web シェルは http://127.0.0.1:3000 で提供されています。API の liveness と readiness は、http://127.0.0.1:3001/health/live と http://127.0.0.1:3001/health/ready で利用できます。OpenAPI JSON は http://127.0.0.1:3001/api/v1/openapi.json にあり、開発用 Swagger UI は http://127.0.0.1:3001/docs/ にあります。

認証付きナレッジ検索、正規化された詳細、代替案、レビューアクセス権限、安全な curl の例は、Knowledge HTTP API ガイド に記載されています。通常のクライアントは、公開済みのレコードのみを受け取ります。レビューアクセスは明示的であり、運営管理者キーのみ、監査対象です。

ビルド後、MCP クライアントを http://127.0.0.1:3001/mcp に直接接続するか、KNOWNPATH_API_URL と KNOWNPATH_API_KEY を指定して軽量な stdio ブリッジを実行します:

pnpm mcp:stdio
pnpm mcp:inspect --transport stdio

ツール契約、認証、セキュリティ動作、現在の Codex/Claude Code/Cursor/Gemini CLI 設定は、MCP ガイド に文書化されています。

ポータブルな Agent Skill は、サポート対象のコーディングエージェントに、取得した修正を盲目的に適用せずに、いつ、どのように MCP ツールを参照すべきかを教えます。手動の開発インストールと現在の動作契約は、Agent Skill ガイド に文書化されています。

API オリジンと API キーを各エージェントを起動する環境に設定し、Phase 13 のインストーラープランを確認または適用します:

export KNOWNPATH_API_URL='https://your-knownpath-origin.example'
read -rsp 'KnownPath API key: ' KNOWNPATH_API_KEY && export KNOWNPATH_API_KEY && printf '\n'
pnpm knownpath -- install --dry-run --agent all
pnpm knownpath -- install --agent all
pnpm knownpath -- doctor --agent all

CLI はそれらの変数名への参照のみを保存し、URL フォールバックはありません。グローバルまたはプロジェクトスコープで Codex CLI、Claude Code、Cursor、Gemini CLI、and OpenCode サポートします。ユーザーは npx knownpath install を実行できます。リポジトリ開発では pnpm knownpath -- を使用できます。正確な変更内容、Windows セットアップ、バックアップ、競合、更新、アンインストール動作は、インストーラガイド に文書化されています。

API をデプロイする

ルートの render.yaml は、Fastify API 用に 1 つの Render Web サービスを定義し、データベースとして MongoDB Atlas を維持します。意図的に worker、ダッシュボード、またはその他者のデータストアはデプロイされません。セットアップ前に以前公開された認証情報をローテーションし、Render デプロイガイド に従って、Blueprint、Atlas ネットワークアクセス、ヘルス検証、およびデプロイ後の API キーフローを進めてください。

名前付き開発ボリュームを削除せずに MongoDB を停止します:

pnpm dev:infra:down

リポジトリコマンド

コマンド

目的

pnpm install

固定されたワークスペースの依存関係をインストールする

pnpm dev

ワークスペースの開発タスクを実行する

pnpm build

コンパイル可能なすべてのアプリケーションとパッケージをビルドする

pnpm typecheck

ワークスペース全体の厳格な TypeScript 検証を実行する

pnpm lint

ワークスペース全体に ESLint のフラット設定を実行する

pnpm format

サポート対象ファイルを Prettier でフォーマットする

pnpm format:check

ファイルを変更せずにフォーマットを検証する

pnpm dev:infra

必要なローカル MongoDB コンテナを起動する

pnpm dev:infra:down

データボリュームを保持したままローカルコンテナを停止する

pnpm db:init

MongoDB コレクション、バリデータ、インデックスを冪等に作成/調整する

pnpm db:inspect

現在のコレクションのバリデータとインデックスを出力する

pnpm db:verify

リポジトリ層の永続化ラウンドトリップを実行してクリーンアップする

pnpm auth:user:create

マスクされたパスワードプロンプトでユーザー/管理者を安全にプロビジョニングする

pnpm ingest:github

公式 API 経由で設定された地道な GitHub ソースを収集する

pnpm ingest:sources

標準化された公式ドキュメントとリリースフィードを発見または同期する

pnpm extract

制限された公開ソース候補を抽出または検査する

pnpm score

エビデンスを検証し、不変の候補評価を作成/検査する

pnpm canonicalize

候補のプロファイル化、比較、レビュー、マージ、分割、再割り当て、再構築を行う

pnpm run search

正規化された KnownPaths を検索のための投影、埋め込み、インデックス、検査、クエリを実行する

pnpm mcp:stdio

stdio 上で軽量なローカル MCP から HTTP へのブリッジを実行する

pnpm mcp:inspect

公式 SDK クライアントで MCP ツールを一括表示または呼び出す

pnpm knownpath -- …

このチェックアウトからマルチエージェントインストーラー CLI を実行する

構造

apps/
  api/             Fastify HTTP process
  cli/             Publishable installer CLI and stdio bridge entry point
  mcp-server/      Thin stdio MCP bridge to the authenticated HTTP API
  web/             Next.js application shell
  worker/          Source ingestion and future background processing runtime
packages/
  agent-adapters/  Safe detection/configuration adapters and ownership state
  ai/              Gemini provider, privacy gate, prompts, validation, and extraction lifecycle
  auth/            Sessions, API keys, principals, authorization, and audit
  config/          Typed environment parsing
  database/        MongoDB lifecycle, repositories, validators, and indexes
  domain/          Versioned domain schemas and canonicalization helpers
  canonicalization/ Deterministic blocking, optional embeddings, and canonical projections
  github-ingestion/ GitHub API collection and source normalization
  source-ingestion/ Official documentation/feed discovery and normalization
  verification/    Deterministic evidence verification and immutable seed scoring
  search/          Embeddings, search projections, hybrid retrieval, and explainable ranking
  mcp/             Shared MCP tool contracts, projections, server factory, and HTTP gateway
  typescript-config/ Shared strict compiler configurations
skills/
  knownpath/        Portable Agent Skill instructions and on-demand examples

現在の境界と進捗状況については、アーキテクチャガイド、データモデル、検索ガイド、Knowledge HTTP API ガイド、MCP ガイド、Agent Skill ガイド、インストーラガイド、デプロイガイド、意思決定ログ、フェーズ進捗 を参照してください。

ライセンス

KnownPath は Apache License 2.0 の下でライセンスされています。

Maintenance

ActivitySlowing
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers