LLM最適化機能

Apidogのバージョンは2.7.2以上である必要があります。

共有 -> ドキュメントサイト -> LLM最適化機能に移動して、以下のオプションを有効にします。

「MCP」を有効化にする

有効にすると、ドキュメントに「MCP」ボタンが表示され、エンドユーザーがCursorやClineなどのMCP対応IDEで現在のAPIドキュメントをどのように使用するかを案内します。詳細については、Apidog MCPサーバーを介してApidogが公開したオンラインAPIドキュメントをAIに接続するを参照してください。

「Copy Page」を有効にする

有効にすると、ドキュメントに「Copy page」ボタンが表示されます。ユーザーはウェブページをMarkdownとしてLLMにコピーできます。

LLMs.txtを有効化にする

有効にすると、ドキュメントサイトのルートディレクトリにllms.txtというMarkdownファイルが生成されます。このファイルには、サイト上のすべてのMarkdownページへのリンクと簡潔な説明が含まれています。例：

AIアシスタントはLLMs.txtをどのように使用できますか？

LLMs.txtと関連するMarkdownファイルを使用する一般的な方法は2つあります：

1. URLにアクセスできるAIアシスタントとMarkdownリンクを共有する

Apidogを介して公開された各オンラインドキュメントページにはMarkdownバージョンがあります。以下の方法でアクセスできます：

任意のドキュメントURLに .md を追加する（例：https://example.apidog.io/page.md）

または、オンラインドキュメントで「View as Markdown」をクリックする

Webブラウジング機能を持つAIアシスタントは、これらの .md URLを使用して簡潔なドキュメントを取得できます。

例として、Cursorで「この情報を理解して：https://zojphlasi1.apidog.io/find-pet-by-id-12888653e0.md を参照し、TypeScriptクライアントを生成してください」と依頼できます。

プロンプトの形式は、使用するAIツールの特定のルールに従う必要があります。例えば、Cursorでは、URLは @ で始まる必要があります。

2. URLにアクセスできないAIアシスタントのためにMarkdownコンテンツをコピーする

AIアシスタントがURL経由でコンテンツにアクセスできない場合、Markdownコンテンツを手動でコピーして貼り付ける必要があります。

オンラインドキュメントで「Copy Page」ボタンをクリックして、現在のページのコンテンツをMarkdown形式で取得し、それをAIアシスタントとの会話に貼り付けます。

例のプロンプト：
「このAPI定義に基づいて、TypeScriptクライアントを生成してください：（コピーしたコンテンツをここに貼り付けてください）。」

よくある質問

LLMs.txtを有効にすることでドキュメントのセキュリティに影響はありますか？

いいえ。 LLMs.txtにはすでに公開されているコンテンツのみが含まれています。HTMLをMarkdownに変換するだけで、非公開または未公開のドキュメントを公開することはありません。アクセス制御（パスワード、IP許可リスト、メール許可リストなど）が設定されている場合、ユーザーはLLMs.txtおよびMarkdownファイルにアクセスするために認証を通過する必要があります。

ドキュメントがパスワード、IP、またはメール許可リストで保護されている場合でもLLMs.txtを使用できますか？

Apidogアプリで「Copy Page」ボタンが表示されないのはなぜですか？

AIアシスタントに「Web Search」機能を有効にしましたが、なぜURL経由でウェブページのコンテンツを読み取れないのですか？

AIアシスタントがURL経由でMarkdownファイルにアクセスできない場合、どうすればよいですか？

LLMs.txtを有効にした後、他に何かする必要がありますか？

LLMs.txtが正常に機能していることを確認するにはどうすればよいですか？

「MCP」を有効化にする#

「Copy Page」を有効にする#

LLMs.txtを有効化にする#

AIアシスタントはLLMs.txtをどのように使用できますか？#

よくある質問#

「MCP」を有効化にする

「Copy Page」を有効にする

LLMs.txtを有効化にする

AIアシスタントはLLMs.txtをどのように使用できますか？

よくある質問