エージェント向けエクスポート

ドキュメントを読み取り専用のMarkdownコーパスとして公開します。

概要

agentExportを有効にすると、現在のドキュメントを静的なエージェント向けファイルとして公開できます。Cloudflare、MCPサーバー、データベース、AIプロバイダーは不要で、どの静的ホストでも利用できます。新規プロジェクトでは選択しない限り無効です。名前付きのsearchとfetchツールで接続する場合はMCPサーバーを参照してください。

エクスポートを有効にする

イニシャライザーで「Agent export」を選ぶか、プロンプトを使わずに生成します。

pnpm create zudo-doc my-docs --agent-export --yes

既存プロジェクトでは、zfb.config.tsのzudoDoc({ ... })にagentExport: trueを追加し、再ビルドします。

export default defineConfig(
  zudoDoc({
    siteUrl: "https://docs.example.com",
    agentExport: true,
  }),
);

安定した絶対URLを引用に使えるよう、公開サイトのsiteUrlを設定してください。空の場合、成果物とページのURLはbase付きのパスになることがあります。MCPサーバーはリクエスト元のオリジンで解決できます。エクスポートには設定済みのbaseが適用されます。

既存サイトから削除するには、agentExport: falseにするかフィールドを削除し、再ビルド・再デプロイします。以前アップロードしたファイルを保持するホストでは、古い/agent/v1/ファイルも削除してください。mcp: trueも設定している場合は、先にMCPを無効にします。

公開されるファイル

現在のビルドは、設定したbaseの下に次のバージョン付き構成を書き出します。

<base>/agent/v1/manifest.json
<base>/agent/v1/search-index.json
<base>/agent/v1/items/<item-key>.json
<base>/agent/v1/pages/<page-key>.md

baseが非ルートの場合、ファイルはdist/<base>/agent/v1/に書き出されます。デプロイでdist/全体をbase配下へ移動するためにcopyPublicWithBase: falseを設定している場合は、二重のパスにならないようdist/agent/v1/に書き出されます。移動後は<base>/agent/v1/で配信され、llms.txtとマニフェストのURLもそのまま解決できます。

manifest.jsonにはサイト、言語、コンテンツのフィンガープリント、文書、取得項目、人が読むページのURL、成果物のURLが含まれます。search-index.jsonにはブラウザー検索とは独立して、正規化された項目の全文が入ります。各項目ファイルにはid、title、text、url、metadataがあり、メタデータは言語、親ページ、フィンガープリント、1から始まる分割番号と総数を示します。ページの.mdファイルには正規化された本文全体が入ります。長いページは取得可能な複数の項目に分割され、本文が黙って切り捨てられることはありません。項目IDは生成されたキーであり、ソースパスではありません。

フィンガープリントは同一ビルドの整合性を示すもので、改訂履歴ではありません。公開中の変更履歴ページは通常のコンテンツです。draft、unlisted、search_exclude、およびルートを持たないcategory_no_pageページは対象外です。実体のある各言語の文書だけを書き出し、言語フォールバックから複製は作りません。ビルド時の正規化では、文章、見出し、リンク、画像、表、注記の本文、コードを残します。表現できない動的MDXは、リクエスト時に実行せず、未対応であることを明示します。相対リンクは元のページを基準に解決されます。引用には人が読むページのURLを使ってください。

静的ホスティングとアクセス

通常どおり生成したdist/を公開します。クライアントはマニフェストとMarkdownを直接読むか、llms.txtをブラウザーで明示的に開けます。これらの形式を置くだけで、すべてのAIクライアントが自動的に発見するわけではありません。

これは公開コーパスです。robots.txt、noindex、unlisted、search_excludeは公開範囲を調整するもので、認証ではありません。保護された文書には有効にしないでください。将来の保護付きデプロイでは、/mcpだけでなく同等の静的成果物すべてを保護する必要があります。取得した文書は信頼できない資料として扱い、コマンドの実行やツール権限の拡大を指示するものとして扱わないでください。