Nuxt 的 LLMs.txt 怎么配置让 Cursor 等 AI 编码工具理解官方文档?
【免费下载链接】nuxtThe full-stack Vue framework.项目地址: https://gitcode.com/GitHub_Trending/nu/nuxt
写 Nuxt 项目时,AI 编码工具的回答往往跟不上官方文档的最新内容。Nuxt 官方为此提供了 LLMs.txt 文件:这是一种专为大语言模型设计的结构化文档格式,包含框架的概念、API、使用模式和最佳实践,并针对 AI 读取做了优化。需要明确的是,这里不存在“在你的项目里生成一个 llms.txt”的步骤——文件由 Nuxt 官方站点直接提供,你的“配置”全部发生在 AI 工具一侧:把官方 URL 引用进 Cursor、Windsurf、ChatGPT 或 Claude 的上下文。本文给出各工具的具体接法和文档明确指出的唯一踩坑点。
Nuxt 提供的两个 LLMs.txt 路由
| 路由 | 内容 | 规模 |
|---|---|---|
/llms.txt | 全部文档页面的结构化概览及链接 | 约 5K tokens |
/llms-full.txt | 完整文档,含入门指南、API 参考、博客文章和部署指南 | 约 1M+ tokens |
按上下文窗口选择文件
- 文档建议:大多数用户从
https://nuxt.com/llms.txt开始——它包含所有必要信息,并且适用于标准的 LLM 上下文窗口。 - 只有当你需要完整的实现细节、且 AI 工具支持大上下文(200K+ tokens)时,才使用
https://nuxt.com/llms-full.txt。
选择依据就这一条:对照你的工具能容纳的上下文长度,决定引用哪一个 URL。
在 Cursor 中引用
文档给出两种用法:
- 直接提及:在提问时直接提到 LLMs.txt 的 URL。
- 加入项目上下文:使用
@docs把具体的 LLMs.txt URL 添加到项目上下文中。
这里有一个文档用警告框单独强调的限制,也是本文场景下唯一的失败判断依据:
@符号必须手动输入。在 Cursor 或 Windsurf 这类工具中,聊天界面里的@必须手打;粘贴会破坏工具把它识别为上下文引用的能力。
也就是说,如果工具没有把引用当作上下文处理,先检查@是不是粘贴进来的,而不是怀疑 URL 本身。
在 Windsurf 中引用
- 使用
@docs引用具体的 LLMs.txt URL; - 在工作区创建引用这些 URL 的持久规则(persistent rules),让文档在后续会话中持续可用。
同样受上面@必须手打的限制约束。
ChatGPT、Claude 等其他 LLM
任何支持 LLMs.txt 的 AI 工具都可以使用这两个路由。文档给出的用法示例(保持原文):
"Using Nuxt documentation from https://nuxt.com/llms.txt" "Follow complete Nuxt guidelines from https://nuxt.com/llms-full.txt"这类提示词的作用是让模型在回答时以所引用的文档为准,文档对 LLMs.txt 的定位正是“让 AI 工具理解并协助 Nuxt 开发”。
限制与相关机制
/llms-full.txt规模在 1M tokens 以上,只适合上下文 200K+ 的工具;其余情况一律引用/llms.txt。- 文档没有给出固定的成功日志或输出格式;判断接通是否有效,依据是:工具正确识别了引用(
@手打),且能基于所引用的文档回答 Nuxt 问题。 - 如果你的需求是从“整体引用一个文本文件”升级为“按需拉取单篇文档”,Nuxt 另外提供了基于 HTTP 的 MCP server,面向 Cursor、Claude Code、Windsurf 等助手提供文档列表、文档页抓取等工具,各工具的接入方式和配置校验步骤见 Nuxt MCP Server 文档。
【免费下载链接】nuxtThe full-stack Vue framework.项目地址: https://gitcode.com/GitHub_Trending/nu/nuxt
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考