使用 llms.txt 与 Cursor 和 Claude Code:具体实用手册

发布: (2026年5月3日 GMT+8 19:56)
7 分钟阅读
原文: Dev.to

Source: Dev.to

请提供您希望翻译的具体文本内容,我将为您翻译成简体中文并保留原有的格式、Markdown 语法以及技术术语。谢谢!

Location

把它放在那里

官方文档服务器

https://example.com/llms.txt(由库/供应商维护)

您的仓库

  • 仅使用 URL(以及简短的协议),放在 agent 规则中——而不是复制它们的文档
  • .cursor/rules/ – 项目映射、约定、您的架构——而不是 Next.js 的完整手册

如果您将上游文档的数千个 token 粘贴到规则中,每次聊天都会为此付费。将指针保留在规则中并按需加载文档可以避免这种情况。

创建类似 .cursor/rules/external-llms-docs.md 的文件(文件名无关紧要;保持作用域)。粘贴一份您实际使用的 llms.txt URL 稳定列表,并进行分组,以便人类和代理能够快速浏览。

外部文档 — 按需获取

索引 URL(请先阅读)

阅读顺序

  1. 为拥有该问题的依赖 fetch llms.txt
  2. 仅跟随该文件中的链接(或明显的 /docs/*.md 兄弟文件)进行深入。
  3. 优先使用 Markdown 源文件,而不是抓取营销 HTML。
  4. 如果本地存在类型定义(node_modules、存根),在确认使用哪个 API 表面后再使用(避免猜错符号)。

范围

  • 关于 我们 仓库布局的提问 → 使用 repo-map 规则 / 代码库搜索,而不是 llms.txt
  • 关于 他们 的 API/版本/文档的提问 → 使用上表。

为什么要单独的文件:Cursor 会根据上下文注入规则;一个庞大的全局规则文件会让无关的编辑变得更沉重。将内部指针与外部指针分离。明确顺序可防止模型默认“在 node_modules 中 grep 一小时”。

外部 SDK 协议

当用户请求的行为依赖于外部库的版本或 API 时:

  1. 确认是哪一个依赖拥有该特性(查看 package.json / import)。
  2. 若该依赖在此文件中列出了 llms.txt在编写代码前先 fetch
  3. 用不超过 10 行的文字概述:版本假设、文件名以及你将使用的 API——随后实现。
  4. 不要 把完整的上游页面原文返回给用户;只引用章节/节或 URL 路径。

示例 – 实现功能(例如 App Router 身份验证中间件)

  • 用户: “添加基于中间件的 Next.js App Router 身份验证。”
  • 代理: fetch https://nextjs.org/llms.txt,打开其中描述 middleware.ts / matcher 模式的页面。
  • 使用当前文件名和签名实现——而不是凭记忆。

调试示例 – Tailwind 类名升级后失效

  • 用户: “Tailwind v4 类名在升级后失效。”
  • 代理: 首先 fetch Tailwind 的 llms.txt;确认破坏性变更说明和配置文件名,然后打开仓库中的 tailwind.config.* / CSS 入口。

分层 SDK 转储(示例模式)

有些站点会提供一个简短索引和一个完整包(名称各异)。经验法则:先从短的开始,只有在存根未能回答时才升级到完整的。

文档主机上的假设布局

/llms.txt          → 链接 + 概览
/llms-small.txt    → 最小表面(低成本)
/llms-full.txt     → 完整内容(高成本)

将规则指向入口(llms.txt);让获取的内容告诉代理是否存在 *-full

你可以在不修改规则的情况下对任务进行微调:

  • “编辑前:fetch Next.js llms.txt 并确认中间件文件名及导出形状。”
  • “使用 ADK llms.txt;不要依赖训练截止时间来判断 API 名称。”
  • “在 fetch Tailwind llms.txt 后,列出使用的文档 URL(仅路径)。”

内部平台 — LLM 索引

认证

数据层

.cursor/rules/external-llms-docs.md 中添加一行:

Internal platform | https://internal-docs.example.com/llms.txt

与供应商文档的机制相同。

操作说明

  • 代理必须能够检索 HTTPS 文本(内置 fetch、浏览器工具、MCP fetch 等)。对空气隔离的机器,需要提供后备方案(在规则中镜像片段、使用本地静态服务器,或使用供应商 tar 包——但接受常驻 token 成本)。
  • 不要在规则中放置带有密钥的已认证 URL;请使用公开文档或在普通 markdown 之外的内部 SSO‑aware 工具。
  • 避免将完整的上游 Markdown dump 到 .cursor/rules;这会导致 token 使用量膨胀。
  • 跳过 llms.txt 并随意爬取营销页面会浪费 token 并产生噪音。
  • docs/vendor/ 下复制供应商文档并对所有内容建立索引是没有必要的,除非你真的需要离线访问。
  • 对于编码代理来说,优势在于可预测的 Markdown 入口点和更小的常驻上下文——而不是 SEO 效益。

添加 .cursor/rules/external-llms-docs.md,其中包含 llms.txt URL 表格以及读取顺序和范围(外部 vs 内部仓库映射)。教导代理:先获取索引 → 跟随链接的 Markdown → 再处理本地类型。当提供商提供分层文件时,采用浅层优先的方式。可选地为内部平台自行托管 llms.txt;仍然仅将规则保留为指针。

0 浏览
Back to Blog

相关文章

阅读更多 »

让客户交接轻松的文件夹结构

每家机构都有这样一个版本的故事:团队成员离职、客户升级,或者你在替病假的同事顶班——于是你花了20分钟去搜索……