mcpField
L
llms-txt

llms-txt

github.com/thatrebeccaraeマーケティング・グロース187107 回インストール24 週間前に更新
リポジトリ

llms-txt について

llms-txtは、プロジェクトのリポジトリやドキュメントサイト向けに、厳選したllms.txtを作成・管理するスキルです。内容をスキャンして優先順位を付け、生成、監査、更新を支援します。

主な機能

  1. 01リポジトリからllms.txtを生成
  2. 02リンクと内容の網羅性を監査
  3. 03編集済みの記述を保って更新
  4. 04LLM向けにドキュメントを選別
  5. 05llms-full.txtの任意生成

活用シーン

  1. 01新規プロジェクトのAI検索対応
  2. 02ドキュメント変更後のllms.txt確認
  3. 03リンクと説明文の更新
  4. 04LLM向けドキュメント案内の作成

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/thatrebeccarae/claude-marketing --skill llms-txt

インストール後、Claude Code で/llms-txtを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

EXAMPLES.md
LICENSE
REFERENCE.md

詳細

llms.txt ジェネレーター

AI 回答エンジンがプロジェクトを正確に提示できるよう、llms.txt ファイルを生成して管理します。

インストール

git clone https://github.com/thatrebeccarae/claude-marketing.git && cp -r claude-marketing/skills/llms-txt ~/.claude/skills/

使用するタイミング

  • 新しいオープンソースプロジェクトやドキュメントサイトを公開するとき
  • ドキュメントを大幅に再構成または全面的に見直すとき
  • AI 検索(ChatGPT、Perplexity、Google AI Overviews)でのプロジェクトの可視性を高めるとき
  • AI に見つけられやすくするための標準に沿ってプロジェクトを整備するとき
  • リポジトリに大きな変更があった後、定期的に情報を更新するとき

llms.txt とは

llms.txt は、プロジェクトのルートに配置するプレーンテキストの Markdown ファイルです。LLM に、プロジェクトの最も重要なコンテンツをまとめた案内を提供します。AI の理解に向けた robots.txt のようなものと考えてください。クローラーのアクセス先を指示するのではなく、何が重要か、プロジェクトがどのように構成されているかを伝えます。

この仕様は Answer.AI によって提案され、llmstxt.org に記載されています。開発者向けツール、ドキュメントサイト、オープンソースプロジェクトで採用が広がっています。llms.txt があるプロジェクトは、AI が内容を理解し、正確に引用して推奨しやすくなります。

使い方

/llms-txt generate [repo-path]

リポジトリをスキャンし、新しい llms.txt ファイルを生成します。パスを指定しない場合は、現在の作業ディレクトリを使用します。

/llms-txt audit [repo-path]

既存の llms.txt について、網羅性、リンク切れ、古くなった説明、優先度の高いコンテンツの不足を確認します。具体的な推奨事項を含むレポートを作成します。

/llms-txt update [repo-path]

現在のリポジトリの状態に基づいて、既存の llms.txt を更新します。手動で作成された説明を維持しながら、新しいコンテンツを追加し、削除されたファイルへの参照を取り除きます。

手順

ステップ 1:リポジトリ構造をスキャンする

リポジトリ内にある、ドキュメントに関連するすべてのファイルを特定します。

  • README.md(ルートおよび重要なサブディレクトリ)
  • docs/ ディレクトリとその内容
  • API ドキュメント(OpenAPI 仕様、API リファレンスページ)
  • チュートリアル、ガイド、入門用コンテンツ
  • CHANGELOG.md、CONTRIBUTING.md、FAQ.md
  • アーキテクチャおよび設計判断に関するドキュメント
  • 設定およびデプロイガイド
  • 独自の README を含むサンプルディレクトリ
ステップ 2:コンテンツの優先順位を付ける

プロジェクトを理解しようとする LLM にとっての重要度に基づき、見つかったコンテンツをランク付けします。

優先度コンテンツの種類重要な理由
P0README、入門ガイド、API リファレンス入口となる情報 — プロジェクトの概要と使い方
P1チュートリアル、ガイド、アーキテクチャドキュメントより深い理解につながる情報 — 仕組みや一般的なワークフロー
P2CHANGELOG、CONTRIBUTING、FAQ、設定ドキュメント補足情報 — 履歴、コミュニティ、トラブルシューティング
ステップ 3:メタデータを抽出する

各コンテンツページについて、次の情報を抽出するか記述します。

  • タイトル:明確で内容を表すページタイトル
  • URL またはパス:コンテンツの場所(ホストされたドキュメントの場合は完全な URL、リポジトリ内のファイルの場合は相対パス)
  • 説明:ページの内容を要約した、行動指向の一文
ステップ 4:llms.txt を生成する

仕様の形式に従ってファイルを組み立てます。

  1. タイトル行:# Project Name
  2. 説明ブロック:プロジェクトの機能、対象ユーザー、主な用途をまとめた 2~3 文
  3. セクション:コンテンツを論理的に分類します(例:「入門ガイド」、「API」、「ガイド」、「コミュニティ」)
  4. コンテンツ項目:各項目は、コロンで区切った説明付きの Markdown リンクとします

正確な形式の仕様については REFERENCE.md を参照してください。

ステップ 5:必要に応じて llms-full.txt を生成する

有用なプロジェクトでは、主要なページの実際の内容を埋め込んだ拡張版を生成します。ドキュメント全体が 1 つのコンテキストウィンドウに収まる、小規模なプロジェクトで役立ちます。

ステップ 6:ユーザーによるレビュー

生成した llms.txt を提示し、レビューしてもらいます。コンテンツを整理する際に行った判断を明示します。

  • 除外したコンテンツとその理由
  • 既存のメタデータから抽出した説明と、推定した説明の区別
  • AI に見つけられやすくするために、ドキュメントの追加が有効なセクション
ステップ 7:リポジトリのルートに保存する

llms.txt(必要に応じてllms-full.txtも)をリポジトリのルートに保存します。

ドキュメントをホストするサイトがあるプロジェクトでは、ホスト版の推奨配置場所(サイトのルートなど。例:https://docs.example.com/llms.txt)も記載してください。

ホスト型ドキュメントとGitHub Pages

プロジェクトにドキュメントサイト(GitHub Pages、ReadTheDocs、Docusaurusなど)がある場合:

  • リポジトリ内のファイルパスではなく、ホスト型ドキュメントを指す完全なURLを使ってllms.txtを生成します
  • https://yourdomain.com/llms.txtで配信される場所にファイルを配置します
  • GitHub Pagesの場合:自動的にデプロイされるよう、llms.txtをドキュメントのソースディレクトリに追加します
  • llms.txtをサイトマップに追加するか、robots.txtからリンクすることを検討してください

重要な原則

  1. 厳選し、すべてを詰め込まない。 リポジトリ内のすべてのファイルを列挙したllms.txtは、役に立たないどころか逆効果です。LLMがプロジェクトを最も明確に把握できる、特に重要なページを10~30件選びます。
  2. 入口を優先する。 最初の数項目で、「これは何か」「誰を対象にしているか」「どう始めるか」がわかるようにします。
  3. 説明は行動につながるものにする。 「認証設定ページ」よりも「SSOプロバイダーの認証を設定する方法」のほうが適切です。
  4. 読者のメンタルモデルに合わせる。 リポジトリの構成ではなく、新規ユーザーがプロジェクトを学ぶ順序に沿ってセクションを整理します。
  5. 常に最新の状態を保つ。 リンク切れや古い説明が含まれるllms.txtは、信頼を損ないます。ドキュメントを大幅に変更した後は/llms-txt auditを実行してください。

他のスキルとの連携

  • aeo-geo-optimizer — llms.txtは、AI検索の最適化全般を補完します。AIからの発見可能性を最大限に高めるには、両方を使用してください
  • technical-seo-audit — llms.txtを生成する前に、AIクローラーがドキュメントにアクセスできることを確認します
  • github-readme — 優れたllms.txtの基盤となるのは、質の高いREADMEです。まずREADMEを最適化してください

仕様の完全な形式、優先順位の評価基準、配置方法については、REFERENCE.mdを参照してください。

コメント