Agent-Orientation Note を llms.txt に追加

shoelace-style/webawesome

Web Awesome が生成する llms.txt に、AI エージェントやコーディング アシスタント向けに Agent Skills の概要とインストール手順を記載した段落が加わります。これにより、LLM がパッケージの提供スキルを把握した上で UI を構築できるようになります。

背景

Web Awesome はビルド時に llms.txt を自動生成し、LLM 用の標準化されたコンポーネント API を提供しています。生成物は H1 → blockquote → ## Documentation / ## Components という構造で、AI が参照しやすい形に整形されています。

しかし、AI エージェントが利用できる Web Awesome Agent Skills の存在とインストール方法が文書に記載されていなかったため、エージェントがスキルを自動的に認識できませんでした。webawesome-app の議論([#394])でこのギャップが指摘され、llms.txt に直接案内を埋め込む方針が立ち上がりました。

この追加により、llms.txt を読むエージェントはスキル情報を取得でき、別途ドキュメントを参照する手間が省かれます。

技術的な変更

packages/webawesome/scripts/llms.js に、生成される概要ブロックの末尾に Agent Skills の紹介文が挿入されました。具体的には、フォントアイコンに関する記述の直後に 6 行のテキストが追加されています。

+For AI agents and coding assistants building with Web Awesome: two Agent Skills ship with the package. The `webawesome` skill is this component reference in progressive, on-demand form; the companion `webawesome-design` skill covers full-page layout (`<wa-page>`), theming, brand color, and visual composition. After installing `@awesome.me/webawesome`, register them with `npx skills add ./node_modules/@awesome.me/webawesome/dist/skills/webawesome`
+and `npx skills add ./node_modules/@awesome.me/webawesome/dist/skills/webawesome-design`. See ${baseUrl}/docs/ai/agent-skills for both.

この変更は コードロジック を変えるものではなく、文字列リテラルの追加のみです。生成プロセスは既存のフローを踏襲し、dist-cdn/llms.txtdist/llms.txt の両方に同一内容が出力されます。

設計判断

生成ドキュメントにエージェント向け案内を埋め込む 手法が採用されました。別ファイルで案内を管理する代わりに、llms.txt の生成時点で情報を付加することで、ドキュメントの整合性と配布の一貫性が保たれます。

このアプローチは 単一ソース・オブ・トゥルー の原則に沿い、llms.txt が唯一の参照先になることを意図しています。スキル情報が更新された場合はこのスクリプトを修正すれば即座に全ビルドに反映され、重複管理のリスクが低減します。

結果として、AI エージェントがパッケージを利用する際の導入ハードルが下がり、同時にメンテナンスコストも抑えられました。

まとめ

llms.txtAgent-Orientation Note を追加したことで、AI エージェントが Web Awesome の提供スキルとそのインストール手順を自動的に取得できるようになり、ドキュメント生成プロセスのシンプルさと一貫性が強化されました。

記事メタデータ

Generated by:
gpt-oss-120b for DiffDaily
LLM Trace:
5f4aacad

この記事はAIによって自動生成されています。内容の正確性については、必ずソースコードやPRを確認してください。

品質レビュー結果

Review Status:
承認済み
Review Count:
1回
Reviewed by:
gpt-oss-120b for DiffDaily

Review Criteria:

記事構成 ✓ PASS

Title, Context, Technical Detailの存在と明確さ

リード文、背景、技術的変更、設計判断、まとめが揃っており、総論→各論→結論の構成が明確です。

カスタムMarkdown構文 ⚠ WARNING

シンタックスハイライト・GitHubリンク記法の正確性

コードブロックのファイル名付きハイライトは正しい形式です。PRリンクは「[PR #2555]」と記載されており、仕様の「[#123]」形式と若干異なります。また、[#394] がハイパーリンク化されていません。

対象読者への適合性 ✓ PASS

エンジニア向けの適切な技術レベルと表現

エンジニア向けの技術情報に特化しており、初心者向けの過度な説明はありません。

パラグラフ・ライティング ✓ PASS

トピックセンテンス・1段落1トピック・段落長

各セクションは総論→各論→結論の流れで構成され、段落はトピックセンテンスで始まり1段落1トピック、長さも適切です。

Diff内容との照合 ✓ PASS

コードブロックとDiff内容の一致

記事のコードブロックはDiffに記載された追加部分と内容・形式が一致しています。

技術用語の正確性 ✓ PASS

技術用語の正確な使用

用語はPRで使用されたものと一致し、誤用は見られません。

説明の技術的正確性 ✓ PASS

技術的主張の正確性と論理性

技術的な説明はPRの内容と整合しており、誤りはありません。

事実の突合 ✓ PASS

PR情報による主張の裏付け(ハルシネーション検出)

記事の主張はすべてPR情報で裏付けられており、根拠のない数値や推測は含まれていません。

数値・固有名詞の確認 ✓ PASS

PR番号・コミットID・バージョン等の正確性

PR番号(#2555)だけが言及されており、正確です。

タイトル・説明との一致 ✓ PASS

記事タイトル・説明とPR内容の一致

記事タイトルはPRタイトルの意味と一致しています。

外部知識の正確性 ✓ PASS

PRに記載のない外部知識(LTS、サポート状況など)の不使用

バージョンやLTS等の外部知識は記載されていません。

時間表現の正確性 ✓ PASS

時間表現がPR情報と一致しているか

時間表現の歪曲はありません。