エージェント向け情報 (For Agents)
このページでは、AI コーディングエージェント、MCP スキル、およびエンジンの実際の API に基づいて作業を行いたい各種ツール向けに、docs.griptapenodes.com が公開している機械可読(マシンリーダブル)なインターフェースについて説明します。
本サイトをレンダリングしているのと同じファイルが、後処理済み(post-processed)の Markdown としても公開されており、エージェントが直接取得できます。スニペット、マクロ、および mkdocstrings の出力はすべて展開済みであり、raw.githubusercontent.com から直接取得する場合には得られない完全な情報が含まれています。
提供されているインターフェース
/llms.txtは、llms.txt の規約 に基づいてキュレーションされたインデックスです。価値の高い主要ページ(スクリプト作成、プロジェクトシステム、カスタムノード開発、MCP 連携、ノードリファレンスなど)が、短い説明と絶対 URL を伴う名前付きセクションごとにグループ化されています。/llms-full.txtは、ナビゲーション内のすべてのページの後処理済み Markdown を 1 つに連結した完全版ファイルです。エンジン全体のドキュメントを単一のコンテキストウィンドウに投入したい場合に使用します。- 各ドキュメントページは、HTML レンダリングと並んで単体の Markdown としても提供されています。URL はレンダリングされたページ URL に
/index.mdを付加したものになります。例えば、/development/custom_nodes/parameters/index.mdや/retained_mode/index.mdなどです。トップレベルのページは/<page>/index.mdに配置され、ネストされたページはレンダリングされた URL 構造をそのまま反映します。
用途に応じた使い分け
/llms.txt: ドキュメント全体を取得することなく、利用可能な情報を俯瞰・探索したい場合に適しています。概要を把握するのに十分コンパクトで、各セクションの説明からどのページがどのトピックを扱っているかを把握できます。/llms-full.txt: 1 ショットで包括的なグラウンディング(知識注入)を行いたい場合で、十分なコンテキスト予算がある場合に適しています。各ページの Markdown ファイルを llms.txt のセクションで宣言された順序で連結した同一の内容が含まれています。- 個別の
.mdページ: 必要なページがすでに特定できている場合(例: カスタムノードを作成中でパラメータのリファレンスを参照したい場合や、スクリプトを作成中でretained_mode.mdを参照したい場合など)に適しています。
エンジンのグラウンディングに役立つ重要ページ
エージェントに少数のページを読み込ませてブートストラップを行う場合、以下の 5 つのページがエンジンの主要なファーストパーティ API を網羅しています:
安定性と更新方針
- これらのインターフェースは、既存のドキュメントデプロイパイプラインを通じて
mainブランチに追従します。現在公開されているのは単一の最新サーフェスであり、バージョン付き URL(例:/v0.40/llms.txtなど)は現在公開されていません。 - 含まれるページのセットは、
mkdocs.yml内のllmstxtプラグインブロックによって制御されます。新しいドキュメントページを追加しても、自動的に/llms.txtや/llms-full.txtに含まれるわけではなく、該当の設定セクションに追加する必要があります。なお、nodes/配下のリファレンスページは glob パターンによって自動的に取得されます。