llms-txt

LLMs.txt 生成器

为 Web 项目生成符合 llmstxt.org 规范的 /llms.txt 和 /llms-full.txt 文件。

此工作流采用脚本优先的方式：爬取脚本负责梳理仓库结构并查找品牌规范，让 Agent 专注于编写便于大模型理解的上下文文件。

用法

当被要求“生成 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. 起草上下文文件： 使用清单创建所需的两个文件：

   • /public/llms.txt：简要摘要、品牌规范和顶层链接。
   • /public/llms-full.txt：包含所有内容链接的完整清单。

文件规范

llms.txt（简要版）

• 以 H1 标题和简短说明开头。
• 大模型指令部分：明确说明其他 Agent 应如何为此项目撰写内容。
• 顶层链接：指向主要板块（文档、API、组件）。

llms-full.txt（完整记录）

• 列出清单中识别出的每个面向公众的内容文件。
• 按目录分组。
• 为每个主要板块提供一句话说明。

反模式（“犀利观点”列表）

• **让 Agent 手动查找文件：**不要手动运行 ls -R 查找文件；请使用脚本。
• **臆造链接：**仅包含确定性清单中找到的文件。
• **描述含糊：**使用清单中的 summary_snippet，准确说明项目用途。