跳转到内容
Tutorial

将 llms.txt 添加到您的 API 以实现 AI 可发现性

| 8 min read

llms.txt 告诉法学硕士您的 API 的用途,所需的标记比 HTML 少 6 倍。 具有规范格式、两层方法和实际示例的分步教程。

Digital matrix code representing machine-readable text
Photo by Markus Spiske on Unsplash

您以 HTML 格式发布 API 文档。 开发人员读取它们,复制curl命令,并集成您的API。 该工作流程仍然有效。 但是你的“读者”中越来越多的人是法学硕士,他们会处理你的 HTML 文档需要付出一定的代价:一个典型的文档页面在模型提取数据之前会消耗 12,000 个令牌 单一端点 URL。 您的网站附带的 HTML 标签、导航镶边和 JavaScript 添加零值 法学硕士。

llms.txt 解决了这个问题。 这是您域根目录下的一个普通 Markdown 文件,描述了 您的 API 的用途、列出您的端点以及详细文档的链接。 法学硕士解析它的速度减少了 6 倍 比同等 HTML 的标记。 超过 849 个站点已采用它,包括 Anthropic、Cloudflare、 条纹和 Minlify。

llms.txt 是什么(以及不是什么)

llms.txt 由 Jeremy Howard 提出的规范定义了一个标准文件 /llms.txt 在任何网站上。 它使用 Markdown 标题、块引用和链接列表来 向语言模型描述产品。

可以这样想: robots.txt 告诉搜索爬虫要索引哪些页面。 llms.txt 告诉语言模型你的产品的用途以及在哪里可以找到详细信息。

# robots.txt - tells crawlers what to index
User-agent: *
Allow: /

# llms.txt - tells LLMs what your product does
# Served at /llms.txt as structured Markdown

llms.txt 不能替代您的文档站点。 这是一个简洁的索引, 格式化以供机器使用。 人类也可以阅读它,但主要受众是任何法学硕士 在生成代码或回答相关问题之前需要了解您的 API。

规格格式

每行的格式都是有意为之的。 结构如下:

# Product Name

> One-line product description with key capabilities.

## Section Name

- [Link Title](https://example.com/page): Brief description
- [Another Link](https://example.com/other): Brief description

## Optional: Additional sections

More structured content as needed.
  • H1 标题: 您的产品或项目名称。 每个文件一个。
  • 块引用: 产品功能的单行描述。
  • H2部分: 按类别(文档、端点、工具)对链接进行分组。
  • 链接列表: 每行都有一个 Markdown 链接,后跟冒号和描述。

没有 HTML。 没有前题。 没有自定义语法。 任何 Markdown 解析器都可以读取它,任何 LLM 都可以 无需特殊工具即可从中提取结构化信息。

为什么令牌很重要:Markdown 与 HTML

每个法学硕士都有一个上下文窗口。 解析所花费的令牌 <div class="nav-wrapper"><script src="analytics.js"> 是模型无法花费理解的代币 您的 API 架构。 这是数学:

HTML documentation page:     ~12,000 tokens
Same content as Markdown:     ~2,000 tokens
Savings:                      ~83% fewer tokens

HTML 文档页面包含导航栏、页脚、侧边栏、元标记和嵌入式 脚本。 去掉所有这些并转换为 Markdown,你会得到相同的信息 大约是代币的六分之一。 对于在其背景限制附近工作的法学硕士来说,这种差异 确定您的完整 API 参考是否适合单个提示。

两层方法:llms.txt + llms-full.txt

该规范定义了两个具有不同作用的文件:

  • llms.txt 是总结。 产品名称、一行描述、 以及带有简要说明的链接列表。 目标大小:10KB 以下。 法学硕士读到这个 了解您的 API 提供什么,并决定通过哪些链接了解详细信息。
  • llms-full.txt 是完整的参考。 它嵌入内容 这些链接指向单个文件。 请求模式、响应示例、身份验证 流量、错误代码。 目标大小:100KB 以下。 LLM 在需要生成时会读取此内容 针对您的 API 的工作代码。

开始于 llms.txt。 添加 llms-full.txt 一旦你想要LLMs生成 集成代码,无需遵循外部链接。

一步一步:编写自己的 llms.txt

1.从产品标识开始

以包含您的产品名称的 H1 开头,后跟描述您的产品的块引用 用一句话来说。 具体一点。 包括端点数量、关键功能和任何差异化因素。

# Acme API

&gt; REST API for payment processing. 12 endpoints covering charges, refunds, subscriptions, and webhooks.

## Documentation

- [API Reference](https://docs.acme.com/api): Full endpoint reference with request/response schemas
- [Authentication](https://docs.acme.com/auth): API key setup, OAuth 2.0 flows, and webhook signing
- [Quickstart](https://docs.acme.com/quickstart): Send your first charge in 5 minutes

## Endpoints

- Create charge: POST https://api.acme.com/v1/charges
- Get charge: GET https://api.acme.com/v1/charges/:id
- Create refund: POST https://api.acme.com/v1/refunds
- List subscriptions: GET https://api.acme.com/v1/subscriptions
- Create webhook: POST https://api.acme.com/v1/webhooks

该文件需要不到 800 个标记才能解析。 法学硕士现在知道 Acme API 处理付款,有 12 端点,并且可以通过三个链接获取更深入的信息。

2. 列出您的端点以及方法和 URL

对于 API 产品,列出每个端点及其 HTTP 方法和完整 URL。 这是最有价值的 代码生成部分。 知道的法学硕士 POST https://api.acme.com/v1/charges 无需阅读完整文档即可生成有效的curl命令或SDK调用。

3. 机器可读规格链接

如果您发布 OpenAPI 规范,请将其链接到您的 llms.txt。 LLM 可以解析 OpenAPI JSON 并提取参数模式、必填字段和响应类型。 MCP 工具清单相同或 GraphQL 内省端点。

4. 为深层上下文构建 llms-full.txt

从摘要中获取每个端点,并使用请求/响应示例对其进行扩展:

# Botoi API - Full Documentation

&gt; Complete endpoint reference for all 150+ developer utility endpoints.

## IP Geolocation

POST https://api.botoi.com/v1/ip/lookup

Returns city, region, country, ISP, coordinates, and timezone for any IP address.

**Request:**
\`\`\`json
{ "ip": "8.8.8.8" }
\`\`\`

**Response:**
\`\`\`json
{
  "success": true,
  "data": {
    "ip": "8.8.8.8",
    "city": "Mountain View",
    "region": "California",
    "country": "US",
    "isp": "Google LLC",
    "lat": 37.386,
    "lon": -122.0838
  }
}
\`\`\`

## Email Validation

POST https://api.botoi.com/v1/email/validate
...full documentation for every endpoint

包括实际的有效负载,而不是占位符数据。 生成集成代码的 LLM 需要查看 API 返回的确切字段名称、类型和嵌套。

5. 用正确的头球发球

提供两个文件 text/markdown 或者 text/plain 内容类型。 如果你 使用 Nginx:

# Serve llms.txt with correct Content-Type
location = /llms.txt {
    default_type text/markdown;
    add_header X-Robots-Tag "noindex";
}

location = /llms-full.txt {
    default_type text/markdown;
    add_header X-Robots-Tag "noindex";
}

在 Cloudflare Pages、Vercel 或 Netlify 上,将文件拖放到您的 public/ 目录。 托管平台通过文件扩展名为它们提供正确的 MIME 类型。

真实示例:botoi 的 llms.txt

波托伊发球 llms.txtbotoi.com/llms.txtllms-full.txtbotoi.com/llms-full.txt。 这是摘要文件的简要视图:

# Botoi - Developer Utility API &amp; MCP Server

&gt; One API key, 150+ developer utility endpoints, and a 49-tool
&gt; MCP server for AI agents. IP geolocation, email validation,
&gt; DNS, hashing, JWT, QR codes, PDF generation, and more.
&gt; Sub-50ms from Cloudflare's edge. Free tier included.

## Free Online Tools

- [JSON Formatter](https://botoi.com/tools/json-formatter): Format, beautify, minify, and validate JSON data
- [Base64 Encoder/Decoder](https://botoi.com/tools/base64-encoder-decoder): Encode and decode Base64 strings
- [Hash Generator](https://botoi.com/tools/hash-generator): Generate SHA-1, SHA-256, SHA-384, SHA-512 hashes

## Botoi API

- [API Documentation](https://api.botoi.com/docs): Full API reference with interactive playground
- [OpenAPI Spec](https://api.botoi.com/openapi.json): Machine-readable OpenAPI 3.1 specification
- [MCP Tool Manifest](https://api.botoi.com/v1/mcp/tools.json): MCP tool definitions for AI agents

## API Endpoints

- IP geolocation: POST https://api.botoi.com/v1/ip/lookup
- Email validation: POST https://api.botoi.com/v1/email/validate
- DNS lookup: POST https://api.botoi.com/v1/dns/lookup
- Hash generation: POST https://api.botoi.com/v1/hash
...150+ more endpoints listed with method and URL

完整文件列出了每个工具、所有 150 多个 API 端点及其方法和 URL、MCP 服务器 五个 AI 编辑器的配置以及 TypeScript SDK 安装命令。 读这篇文章的法学硕士 文件可以回答“如何使用 botoi 验证电子邮件?” 无需访问单个网页。

自己取:

curl -s https://botoi.com/llms.txt | head -20

生成引擎优化:超越传统 SEO

传统的SEO针对Google的爬虫进行优化。 生成式引擎优化 (GEO) 优化 综合多个来源答案的人工智能模型。 当开发人员询问 ChatGPT“什么 API 我可以用于电子邮件验证吗?”,模型从它已解析或可以获取的源中提取。

llms.txt 是 GEO 战略的一部分。 完整图片包括:

  • llms.txtllms-full.txt 用于直接LLM消费。
  • OpenAPI 规范 在公共 URL 上,以便法学硕士可以解析您的端点架构。
  • MCP 服务器发现 通过 /.well-known/mcp/server-card.json 所以人工智能 助手可以找到并连接到您的工具。
  • 结构化数据 (JSON-LD) 在您的页面上进行更丰富的提取。
  • robots.txt 配置为允许 AI 爬虫(GPTBot、ClaudeBot、 困惑机器人)。

每一层都以法学硕士发现和使用 API 的不同方式为目标。 llms.txt 是 最省力、影响最大的起点。

部署清单

1. Create /llms.txt with product name, description, and key links
2. Create /llms-full.txt with full endpoint documentation
3. Add both files to your robots.txt sitemap (optional)
4. Set Content-Type to text/markdown or text/plain
5. Keep llms.txt under 10KB and llms-full.txt under 100KB
6. Update both files whenever you ship new endpoints
7. Test: curl -s https://yourdomain.com/llms.txt | wc -c

保留你的 llms.txt 与 API 源代码一起进行版本控制。 更新一下 在添加新端点的同一个拉取请求中。 陈旧的文档,无论是对于人类而言 或机器,侵蚀信任。

要点

  • 法学硕士比人类先阅读您的文档。 AI 代理、编码助手和聊天 接口解析 API 文档以生成代码并回答问题。 给他们一个干净的格式。
  • Markdown 的令牌成本比 HTML 少 6 倍。 剥离导航、脚本和样式。 以法学硕士最有效处理的格式提供他们所需的内容。
  • 两个文件涵盖了这两个用例。 llms.txt 是汇总索引。 llms-full.txt 是完整的参考。 从总结开始; 添加完整版本 当您希望法学硕士生成有效的集成代码时。
  • 超过 849 个网站已采用该格式。 Anthropic、Cloudflare、Stripe 和 Mintlify 全部服务 llms.txt。 该格式作为 GEO 标准越来越受到关注。
  • 看看它的实际效果。 拿来 botoi.com/llms.txt 查看单个 Markdown 文件中描述的 150 多个端点 API。

FAQ

什么是 llms.txt 以及它如何工作?
llms.txt 是一个 Markdown 文件,位于您域的 /llms.txt 中。 它以结构化格式描述您的产品、API 端点和文档链接,LLM 可以使用最少的令牌进行解析。 将其视为人工智能的 robots.txt:robots.txt 告诉爬虫要索引什么,llms.txt 告诉语言模型您的网站提供什么。
与 HTML 文档相比,llms.txt 节省了多少标记?
Markdown 使用的标记比同等 HTML 内容大约少 6 倍。 在 HTML 中花费 12,000 个令牌的文档页面在 Markdown 中可以压缩到 2,000 个令牌以下。 这很重要,因为 LLM 的上下文窗口是有限的,并且花在格式化上的每一个令牌都不是花在理解 API 上的令牌。
我是否需要 llms.txt 和 llms-full.txt?
llms.txt 是摘要:产品名称、描述和链接列表。 llms-full.txt 包含链接指向的完整文档内容,嵌入在单个文件中。 从 llms.txt 开始。 当您希望 LLM 具有深入的上下文而不需要遵循多个链接时,请添加 llms-full.txt。
今天哪些 AI 工具可以读取 llms.txt?
Claude、ChatGPT、Perplexity 和 Cursor 在浏览或引用文档时都会读取 llms.txt。 基于 MCP 的代理和编码助手也会获取它以进行工具发现。 截至 2026 年初,超过 849 个网站已采用该格式,包括 Anthropic、Cloudflare、Mintlify 和 Stripe。
我应该在哪里托管 llms.txt 文件?
将其放在您的域根目录中:https://yourdomain.com/llms.txt。 使用 text/markdown 或 text/plain 作为内容类型。 如果您有 API 子域,请考虑在主域和 API 子域中提供它。 对于摘要版本,请将文件保持在 10KB 以下。

开始使用 botoi 构建

150+ 个 API 端点,涵盖查询、文本处理、图片生成和开发者工具。免费套餐,无需信用卡。