Llms.txt Documentation测评：让AI更懂你的文档

1 模型概述

1.1 能力评估

Llms.txt Documentation并非传统意义上的大语言模型，而是一个专为AI理解和使用的网站文档标准。根据测评，该项目的核心能力包括：

• 文档索引与导航：提供一个结构化的Markdown索引文件(llms.txt)，帮助AI快速定位和理解网站最重要的内容

• 多格式支持：支持生成简洁版(llms.txt)和完整版(llms-full.txt)两种文档格式，适应不同的上下文窗口限制

• 智能集成：通过MCP服务器与主流开发工具集成，包括Cursor、Windsurf、Claude和Claude Code等

• 自动标记生成：为网站每个页面自动生成Markdown版本，只需在原始URL后添加.md后缀即可访问

1.2 技术特点

Llms.txt的技术特点显著区别于传统文档格式：

• AI友好设计：采用纯Markdown格式，去除HTML、JavaScript和CSS等对AI无用的噪音信息

• 双模式策略：llms.txt作为轻量级索引包含简要描述和链接，而llms-full.txt直接包含所有详细内容

• 标准化结构：遵循固定的Markdown格式，既人类可读又机器可解析

• 递归解析：能够智能处理复杂的数据模型引用和多层嵌套结构

1.3 应用场景

该技术特别适用于以下场景：

• API文档集成：让AI助手准确理解API接口定义，生成相应的客户端代码

• 开发环境增强：在IDE中为程序员提供精准的代码提示和文档支持

• 技术文档优化：为有大量结构化文档的技术型网站提供AI可读的版本

• 检索增强生成(RAG)：通过分块和索引大文档，克服LLM上下文窗口限制

2 安装与部署方式

2.1 基于Apifox的部署（最简方案）

适用系统：Windows、macOS、Linux

Apifox提供了开箱即用的Llms.txt支持，这是最简单的部署方案：

1. 创建或导入API文档

   • 登录Apifox账户，创建新项目或导入现有API文档

2. 发布在线文档

   • 进入「分享文档 > 发布文档站」

   • 配置文档访问权限和基本设置

3. 启用Llms.txt功能

   • 在「AI相关特性」中确保Llms.txt功能处于开启状态（默认开启）

   • 发布文档，系统会自动生成llms.txt和各页面的Markdown版本

4. 验证部署

   • 访问https://你的文档域名/llms.txt查看索引文件

   • 在任何API文档页面的URL后添加.md后缀检查Markdown版本

2.2 手动创建与部署

适用系统：所有支持基本文本编辑和Web托管的系统

对于自定义网站，可以手动创建和部署Llms.txt文件：

1. 创建llms.txt文件

   使用文本编辑器创建Markdown格式的llms.txt文件，结构如下：

   markdown

   # 公司/项目名称
   > 简要描述你的公司或项目做什么
   
   ## 产品
   - [产品API](https://example.com/api): RESTful API文档
   - [SDK指南](https://example.com/sdk): JavaScript SDK实现
   
   ## 文档
   - [入门指南](https://example.com/docs/start): 快速设置指南
   - [认证](https://example.com/docs/auth): OAuth 2.0流程
   
   ## 资源
   - [更新日志](https://example.com/changelog): 最新更新
   - [状态](https://example.com/status): 服务可用性

2. 创建Markdown内容页面

   为每个重要页面创建对应的Markdown版本，存放在相同路径但添加.md后缀：

   • 原始页面：https://example.com/docs/start

   • Markdown版本：https://example.com/docs/start.md

3. 部署到服务器

   将llms.txt文件上传到网站的根目录，确保可通过https://你的域名/llms.txt访问

4. 可选：创建llms-full.txt

   对于内容丰富的网站，可以创建包含完整详细信息的llms-full.txt文件

2.3 通过MCP服务器部署

适用系统：支持MCP协议的开发环境

1. 安装MCP服务器

   使用官方提供的mcpdoc服务器专门为LLM和IDE提供文档服务

2. 工具集成配置

   • Cursor配置：在设置中启用MCP服务器并配置llms.txt路径

   • Windsurf配置：添加自定义文档源指向你的llms.txt文件

   • Claude Code配置：安装MCP插件并连接文档服务器

3. 验证集成

   在IDE中测试AI助手是否能正确引用你的API文档生成代码

2.4 常见问题与解决方案

问题1：AI无法通过URL访问Markdown文件

• 解决方案：使用Apifox的”复制页面”功能手动复制Markdown内容，然后粘贴给AI助手

问题2：文档内容更新后llms.txt未同步

• 解决方案：在Apifox中会自动同步，手动部署时需要重新生成和上传llms.txt文件

问题3：文件过大超出LLM上下文窗口

• 解决方案：使用llms.txt索引文件而非llms-full.txt，或通过IDE的RAG功能自动分块

问题4：权限控制文档无法被AI访问

• 解决方案：对于设置了密码、IP白名单的文档，需要通过”复制页面”手动提供内容给AI

3 配套客户端

Llms.txt Documentation本身是一个标准而非软件，但可以与多种客户端和工具集成：

3.1 主要支持客户端

3.2 客户端配置详解

Apifox配置：

1. 访问Apifox官网注册账户

2. 创建API项目并完成文档编写

3. 进入「分享文档 > 发布文档站 > AI相关特性」

4. 确保Llms.txt功能处于开启状态

Cursor配置：

1. 安装Cursor IDE

2. 在设置中搜索”MCP”

3. 添加新的MCP服务器，配置官方mcpdoc服务器

4. 重启Cursor使配置生效

4 案例讲解：API文档智能查询系统

4.1 案例背景

假设我们正在开发一个”宠物商店API”，需要让AI助手能够准确理解API接口并生成相应的客户端代码。传统网页文档包含大量导航和样式信息，干扰AI理解。

4.2 实施步骤

第一步：创建标准API文档

在Apifox中创建完整的宠物商店API文档，包括：

• 用户认证接口

• 宠物列表查询

• 宠物详情获取

• 订单管理接口

第二步：发布并启用Llms.txt

发布在线文档，并确保Llms.txt功能开启。系统会自动生成：

• https://petstore.apifox.cn/llms.txt – 索引文件

• https://petstore.apifox.cn/api-auth.md – 认证接口Markdown版

• https://petstore.apifox.cn/api-pets.md – 宠物接口Markdown版

第三步：AI集成使用

场景1：生成TypeScript客户端代码

在Cursor中，我们可以直接引用Markdown文档：

@https://petstore.apifox.cn/api-pets.md
请基于这个宠物商店API文档，帮我生成一个TypeScript客户端类，包含所有宠物相关接口的方法。

AI助手会读取简洁的Markdown文档（而不是复杂的HTML页面），准确生成：

class PetStoreAPI {
  private baseUrl: string;
  private token: string;

  constructor(baseUrl: string, token: string) {
    this.baseUrl = baseUrl;
    this.token = token;
  }

  // 获取宠物列表
  async getPets(category?: string, page: number = 1): Promise<Pet[]> {
    const params = new URLSearchParams();
    if (category) params.append('category', category);
    params.append('page', page.toString());
    
    const response = await fetch(
      `${this.baseUrl}/pets?${params.toString()}`, {
        headers: { 'Authorization': `Bearer ${this.token}` }
      }
    );
    
    if (!response.ok) throw new Error('获取宠物列表失败');
    return await response.json();
  }

  // 获取宠物详情
  async getPetById(id: number): Promise<Pet> {
    const response = await fetch(`${this.baseUrl}/pets/${id}`, {
      headers: { 'Authorization': `Bearer ${this.token}` }
    });
    
    if (!response.ok) throw new Error('获取宠物详情失败');
    return await response.json();
  }
}

interface Pet {
  id: number;
  name: string;
  category: string;
  price: number;
  tags: string[];
}

场景2：API接口调试辅助

对于设置了权限的文档，我们可以手动复制Markdown内容：

1. 点击Apifox文档页面的”复制页面”按钮

2. 在AI对话中粘贴并提问：

基于这个API定义，帮我生成Python请求代码测试认证接口：

[粘贴复制的Markdown内容]

AI会基于清晰的Markdown格式准确生成：

import requests

def authenticate_user(username: str, password: str) -> str:
    """
    认证用户并获取访问令牌
    """
    url = "https://api.petstore.com/auth/login"
    payload = {
        "username": username,
        "password": password
    }
    
    response = requests.post(url, json=payload)
    if response.status_code == 200:
        data = response.json()
        return data["access_token"]
    else:
        raise Exception(f"认证失败: {response.status_code} - {response.text}")

# 使用示例
try:
    token = authenticate_user("your_username", "your_password")
    print(f"获取到的令牌: {token}")
except Exception as e:
    print(f"错误: {e}")

4.3 效果对比

使用传统网页文档时，AI可能会误解页面结构或遗漏重要参数。而使用Llms.txt提供的Markdown版本后：

• 准确率提升：接口参数和数据结构理解更精准

• 响应速度加快：处理简洁Markdown比复杂HTML更快

• Token节省：减少无关内容的处理，降低使用成本

5 使用成本与商业价值

5.1 使用成本分析

直接成本：

• 零财务成本：Llms.txt是开放标准，Apifox等工具提供免费支持

• 时间投入：手动创建维护约需1-2小时/月，自动生成则几乎零时间成本

技术成本：

• 学习曲线：极其平缓，Markdown是广泛掌握的简单格式

• 维护负担：自动生成方案无需额外维护，手动方案需随内容更新同步

集成成本：

• 工具兼容性：基于标准Markdown，与几乎所有现代开发工具兼容

• 适配工作量：现有文档系统通常无需重大修改即可支持

5.2 商业价值评估

效率提升价值：

• 开发加速：AI准确理解API文档，代码生成效率提升约30-50%

• 调试时间减少：准确的接口理解减少误解导致的调试时间

• ** onboarding简化**：新团队成员通过AI助手快速掌握项目API

质量提升价值：

• 代码准确性：基于精准文档生成的客户端代码错误率显著降低

• 一致性保证：所有开发者基于同一权威文档源工作

• 知识传承：避免因人员变动导致的API使用知识丢失

竞争优势：

• 技术前沿性：早期采用AI友好文档标准，提升开发者体验

• 生态整合：更好地融入现代AI增强的开发工作流

• 未来适应性：为AI驱动的开发环境演进做好准备

5.3 投资回报分析

采用Llms.txt的投资回报率(ROI)相当可观：

• 微小投入：几乎零财务成本，少量时间投入

• 持续收益：长期提升开发效率和代码质量

• 风险极低：基于开放标准，无供应商锁定风险

• 渐进采用：可以从小范围开始，逐步扩展到全项目

6 综合测评结论

Llms.txt Documentation作为AI时代的文档标准，展现了显著的技术前瞻性和实用价值。虽然目前主要AI提供商尚未正式宣布支持该标准，但其设计理念与AI增强开发的趋势高度契合。

优势：

• 极低的实施门槛和学习曲线

• 显著提升AI处理文档的效率和准确性

• 与现有工具链良好集成

• 为未来的AI标准化交互奠定基础

局限：

• 生态系统仍在发展中，采用率约950个域名

• 依赖工具厂商的主动支持

• 对非技术文档的价值相对有限

推荐评级：★★★★☆（4.5/5）

推荐场景：特别推荐技术文档团队、API提供商和开源项目采用此标准，尤其是那些已经在使用Apifox等支持工具的团队。对于纯内容型网站，可以保持关注，待生态系统更成熟后考虑采用。

Llms.txt代表了文档与AI融合的重要方向，今天的微小投入可能带来明天的显著竞争优势。

关注 “悠AI” 更多干货技巧行业动态