Skip to content

LLMs.txt

EMQX Cloud ドキュメントは llms.txt ファイルを提供しています。これは大規模言語モデル(LLM)向けに設計された構造化ドキュメントインデックスです。AI ツールやエージェントがこのファイルを参照することで、EMQX Cloud のドキュメントコンテンツを素早く発見・参照できるようになり、エージェントの構築や AI コーディングアシスタントの利用時により正確で関連性の高い回答が得られます。

llms.txt とは?

llms.txt は、標準的な URL パスに配置されるプレーンテキストファイルで、製品の主要なドキュメントページを一覧表示します。llms.txt 仕様(ドキュメントを AI フレンドリーにするためのオープン標準)に準拠しています。

AI ツールが llms.txt に対応している場合、このファイルの URL を指定するだけで、コンテンツを手動でコピー&ペーストすることなく、構造化された最新の EMQX Cloud ドキュメントへのアクセスを提供できます。

TIP

llms.txt ファイルはドキュメントのビルドごとに自動生成されるため、常に最新のドキュメント構造とコンテンツを反映しています。

利用可能なファイル

以下のトップレベルインデックスファイルには、EMQX の全製品の llms.txt が一覧表示されています:

https://docs.emqx.com/llms.txt

EMQX Cloud ドキュメント専用の llms.txt もあります:

https://docs.emqx.com/en/cloud/latest/llms.txt

AI ツールにトップレベルインデックスを指定すると、完全なリストを自動的に検出し、適切な製品ドキュメントに移動できます。

AI ツールでの使い方

使用している AI ツールまたはコーディングアシスタントに、トップレベルの llms.txt URL を指定します:

https://docs.emqx.com/llms.txt

具体的な操作方法はツールによって異なります。設定画面でドキュメントソースを直接登録できるツールもあれば、プロンプトに URL を貼り付けるだけのツールもあります。操作方法が分からない場合は、AI ツールに直接尋ねてみてください。例えば:

https://docs.emqx.com/llms.txt をドキュメントソースとして追加するにはどうすればよいですか?

AI ツールが現在のインターフェースでの具体的な手順を案内します。

Markdown 形式でドキュメントにアクセスする

EMQX Cloud ドキュメントのページは、URL の .html.md に置き換えることで、生の Markdown 形式で取得できます。特定のページを AI ツールやスクリプトに直接入力する場合に便利です:

# HTML ページ
https://docs.emqx.com/en/cloud/latest/deployments/auth_overview.html

# 同じページの Markdown 形式
https://docs.emqx.com/en/cloud/latest/deployments/auth_overview.md