llms-txt

LLMs.txt ジェネレーター

llmstxt.org の仕様に従って、Web プロジェクト用の /llms.txt と /llms-full.txt ファイルを生成します。

このワークフローでは、スクリプト優先のアプローチを採用しています。クローラースクリプトがリポジトリ構造の把握やブランドルールの検索といった「作業」を担い、エージェントは LLM が理解しやすいコンテキストファイルの作成という「判断」に専念します。

使用方法

「llms.txt を生成して」「サイトを AI 向けにして」「llms-full.txt を追加して」と依頼された場合：

1. マニフェストスクリプトを実行します：

   python3 ~/.agents/skills/llms-txt/scripts/generate_llms_manifest.py \
     --root "." \
     --out "llms_manifest.json"
   

2. マニフェストを読み込みます： llms_manifest.json を読み込み、以下を確認します：

   • 検出されたブランドガイド（README.md、GEMINI.md など）。
   • すべてのコンテンツファイルの一覧（.md、.mdx、.txt）。
   • プロジェクトの大まかな構造と概要の抜粋。

3. コンテキストファイルを作成します： マニフェストを使って、必要な 2 つのファイルを作成します：

   • /public/llms.txt：簡潔な概要、ブランドに関するガードレール、最上位のリンク。
   • /public/llms-full.txt：すべてのコンテンツリンクを含む包括的なマニフェスト。

ファイルの基準

llms.txt（簡潔版）

• H1 タイトルと簡潔な説明から始めます。
• LLM Instructions セクション：他のエージェントがこのプロジェクト向けに文章を作成する際の明確なルールを記載します。
• 最上位のリンク：主要なセクション（ドキュメント、API、コンポーネント）を示します。

llms-full.txt（完全版）

• マニフェストで特定された、公開対象のコンテンツファイルをすべて列挙します。
• ディレクトリごとにグループ化します。
• 主要な各セクションについて、1 文で説明します。

アンチパターン（「率直な意見」リスト）

• **エージェントの作業：**ファイルを探すために ls -R を手動で実行しないでください。スクリプトを使用します。
• **リンクの捏造：**決定論的なマニフェストで見つかったファイルだけを含めます。
• **曖昧な説明：**プロジェクトの目的を明確にするため、マニフェストの summary_snippet を使用します。