mcpField
C
create-llms

create-llms

github.com/githubAgent 工作流40.5k9.2k 次安装今天更新
代码仓库

关于 create-llms

用于在项目根目录生成符合规范的 `llms.txt` 的仓库技能。它引导 Agent 检查仓库、筛选和组织文件，并创建文件及验证链接。

主要功能

  1. 01检查仓库结构与文档
  2. 02筛选便于大模型理解的文件
  3. 03按 Markdown 章节组织链接
  4. 04在根目录创建 `llms.txt`
  5. 05验证格式与相对链接

适用场景

  1. 01为仓库添加 LLM 导航指南
  2. 02找出关键文档与规范文件
  3. 03检查 `llms.txt` 的链接和结构

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/github/awesome-copilot --skill create-llms

安装后在 Claude Code 中输入/create-llms确认已加载。

详细介绍

根据仓库结构创建 LLMs.txt 文件

按照 https://llmstxt.org/ 上的官方 llms.txt 规范，在仓库根目录中从零创建一个新的 llms.txt 文件。该文件为大模型（LLM）提供高层指导，说明在哪里可以找到用于理解仓库用途和规范的相关内容。

首要指令

创建一个全面的 llms.txt 文件，作为 LLM 理解和有效浏览仓库的入口点。该文件必须符合 llms.txt 规范，并针对 LLM 消费进行优化，同时保持人类可读。

分析与规划阶段

在创建 llms.txt 文件之前，你必须完成全面分析：

第 1 步：查阅 llms.txt 规范
  • 查阅 https://llmstxt.org/ 上的官方规范，确保完全合规
  • 理解所需的格式结构和指南
  • 注意特定的 Markdown 结构要求
第 2 步：仓库结构分析
  • 使用适当的工具检查完整的仓库结构
  • 确定仓库的主要用途和范围
  • 编录所有重要目录及其用途
  • 列出有助于 LLM 理解的关键文件
第 3 步：内容发现
  • 识别 README 文件及其位置
  • 查找文档文件（/docs/、/spec/ 等中的 .md 文件）
  • 定位规范文件及其用途
  • 发现配置文件及其相关性
  • 查找示例文件和代码示例
  • 识别任何现有的文档结构
第 4 步：创建实施计划

根据你的分析，创建结构化计划，包括：

  • 仓库用途和范围摘要
  • 对 LLM 理解至关重要的文件的优先级排序列表
  • 提供额外上下文的次要文件
  • llms.txt 文件的组织结构

实施要求

格式合规

根据规范，llms.txt 文件必须遵循以下确切结构：

  1. H1 标题：包含仓库/项目名称的单行（必需）
  2. 引用块摘要：以引用块格式提供的简要描述（可选但推荐）
  3. 附加详情：零个或多个无标题的 Markdown 部分，用于提供上下文
  4. 文件列表部分：零个或多个包含 Markdown 链接列表的 H2 部分
内容要求
必需元素
  • 项目名称：清晰、描述性的标题作为 H1
  • 摘要：简要说明仓库用途的引用块
  • 关键文件：按类别组织的必要文件（H2 部分）
文件链接格式

每个文件链接必须遵循：[descriptive-name](relative-url): optional description

部分组织

将文件组织成逻辑清晰的 H2 部分，例如：

  • 文档：核心文档文件
  • 规范：技术规范和需求
  • 示例：示例代码和使用示例
  • 配置：设置和配置文件
  • 可选：次要文件（特殊含义 - 可跳过以获得更短的上下文）
内容指南
语言和风格
  • 使用简洁、清晰、明确的语言
  • 避免使用未经解释的术语
  • 同时面向人类和 LLM 读者编写
  • 描述要具体且信息丰富
文件选择标准

包含以下文件：

  • 说明仓库的用途和范围
  • 提供必要的技术文档
  • 展示使用示例和模式
  • 定义接口和规范
  • 包含配置和设置说明

排除以下文件：

  • 纯属实现细节
  • 包含冗余信息
  • 属于构建产物或生成内容
  • 与理解项目无关

执行步骤

第 1 步：仓库分析
  1. 完整检查仓库结构
  2. 阅读主 README.md 以了解项目
  3. 识别所有文档目录和文件
  4. 编目规范文件及其用途
  5. 查找示例文件和配置文件
第 2 步：内容规划
  1. 确定主要目的声明
  2. 为块引用撰写简洁摘要
  3. 将识别出的文件归入逻辑分类
  4. 按对 LLM 理解的重要性对文件进行优先级排序
  5. 为每个文件链接创建描述
第 3 步：文件创建
  1. 在仓库根目录创建 llms.txt 文件
  2. 遵循精确的格式规范
  3. 包含所有必需部分
  4. 使用正确的 markdown 格式
  5. 确保所有链接都是有效的相对路径
第 4 步：验证
  1. 验证是否符合 https://llmstxt.org/ 规范
  2. 检查所有链接是否有效且可访问
  3. 确保该文件可作为有效的 LLM 导航工具
  4. 确认该文件既适合人类阅读也适合机器读取

质量保证

格式验证
  • ✅ 包含项目名称的 H1 标题
  • ✅ 块引用摘要（如果包含）
  • ✅ 用于文件列表的 H2 部分
  • ✅ 正确的 markdown 链接格式
  • ✅ 没有损坏或无效的链接
  • ✅ 全篇格式一致
内容验证
  • ✅ 清晰、明确的语言
  • ✅ 全面覆盖重要文件
  • ✅ 内容组织合乎逻辑
  • ✅ 适当的文件描述
  • ✅ 可作为有效的 LLM 导航工具
规范符合性
  • ✅ 严格遵循 https://llmstxt.org/ 格式
  • ✅ 使用必需的 markdown 结构
  • ✅ 适当实现可选部分
  • ✅ 文件位于仓库根目录（/llms.txt）

示例结构模板

# [Repository Name]

> [Concise description of the repository's purpose and scope]

[Optional additional context paragraphs without headings]

## Documentation

- [Main README](README.md): Primary project documentation and getting started guide
- [Contributing Guide](CONTRIBUTING.md): Guidelines for contributing to the project
- [Code of Conduct](CODE_OF_CONDUCT.md): Community guidelines and expectations

## Specifications

- [Technical Specification](spec/technical-spec.md): Detailed technical requirements and constraints
- [API Specification](spec/api-spec.md): Interface definitions and data contracts

## Examples

- [Basic Example](examples/basic-usage.md): Simple usage demonstration
- [Advanced Example](examples/advanced-usage.md): Complex implementation patterns

## Configuration

- [Setup Guide](docs/setup.md): Installation and configuration instructions
- [Deployment Guide](docs/deployment.md): Production deployment guidelines

## Optional

- [Architecture Documentation](docs/architecture.md): Detailed system architecture
- [Design Decisions](docs/decisions.md): Historical design decision records

成功标准

创建的 llms.txt 文件应当：

  1. 使 LLM 能够快速理解仓库的目的
  2. 为重要文档提供清晰的导航
  3. 严格遵循官方 llms.txt 规范
  4. 全面而简洁
  5. 有效服务于人类和机器读者
  6. 包含所有有助于理解项目的关键文件
  7. 全篇使用清晰、明确的语言
  8. 以逻辑方式组织内容以便于理解

评论

支持 Markdown