乐于分享
好东西不私藏

你的 API 文档加一个 llms.txt,Claude Code 就能用得顺很多

你的 API 文档加一个 llms.txt,Claude Code 就能用得顺很多

YC 掌门人 Garry Tan 最近发了条推,就一句话:「我的 claw 很喜欢你的 API 文档带 llms.txt」。

Claude Code 处理 API 文档截图

配了张截图,是 Claude Code 在读某个带 llms.txt 的 API 文档时的工作状态。这条推文本身没什么信息量,但它戳中了一个实际的痛点。

llms.txt 是什么

简单说:llms.txt 是一个放在网站根目录的纯文本文件,专门给 AI 工具读的。类似 robots.txt 的逻辑,但目标受众是语言模型而不是搜索爬虫。

它的内容通常是把你网站或 API 的核心信息提炼成 AI 好消化的格式——不带冗余的 HTML 标签、不带导航栏广告、不带各种废话,就是干净的结构化文档:有哪些端点、参数是什么、认证怎么做、有什么限制。

这个格式最早由 fast.ai 的 Jeremy Howard 提出,目前还没有统一标准,但已经有越来越多的 API 提供方开始支持。比如 Anthropic 自己的文档就有 https://docs.anthropic.com/llms.txt

Claude Code 为什么会在意这个

Claude Code(Garry Tan 叫它 claw,爪子,大概是 Claude 的谐音梗)在帮你写代码对接某个 API 时,经常需要去查文档。问题是普通的 HTML 文档对模型来说并不友好——

页面里混杂着导航、侧边栏、cookie 提示、各种链接,真正有用的内容占比很低。模型要么抓不到关键信息,要么上下文窗口被无效内容撑满,最后给你一个似是而非的答案。

有了 llms.txt,Claude Code 可以直接拿到提炼好的版本,准确率和效率都会明显提升。你不用再反复纠正它用错的参数名,也不用担心它把某个已废弃的端点当成现行文档来用。

★ 

本质上,llms.txt 是 API 提供方替用户做了一件事:把「让 AI 理解我的文档」这个问题提前解决掉,而不是让每个开发者自己去处理。

如果你维护 API 文档,现在可以做什么

格式并不复杂。一个最小可用的 llms.txt 大概长这样:

123456789101112131415# 你的产品名>一句话描述这个 API 是干什么的## 文档-[快速开始](https://yoursite.com/docs/quickstart): 认证和第一个请求-[API 参考](https://yoursite.com/docs/api): 完整端点列表-[错误码](https://yoursite.com/docs/errors): 常见错误处理## 重要说明-认证方式:BearerToken,放在Authorization头-速率限制:每分钟60次请求-Base URL:https://api.yoursite.com/v1

放到根目录,yoursite.com/llms.txt 能访问到就行。进阶一点的做法是同时提供 llms-full.txt,把所有文档的完整内容都打包进去,给那些需要更多上下文的场景用。