LLMs.txt
把 UDhold 开发文档接入 Cursor、TRAE、Claude 等 AI 工具,让 AI 帮你写插件。
llms.txt 是一个专为大型语言模型设计的站点索引文件,思路类似 robots.txt,但目标不同:robots.txt 告诉搜索引擎爬虫「什么能爬」,llms.txt 则为 AI 工具提供网站内容的结构化摘要,帮助它们更快、更准地理解和引用文档。
UDhold 开发文档已全量适配这一标准,并且随文档更新自动同步——你读到这篇指南时,AI 拿到的就是最新内容。
可用资源
| 地址 | 内容 | 适合场景 |
|---|---|---|
| https://udhold.cn/llms.txt | 全站结构化索引:每个文档页的标题、链接与一句话简介 | 加入工具的文档索引、让 AI 先知道「有什么」 |
| https://udhold.cn/llms-full.txt | 全部文档的 Markdown 全文(含 plugin.json 契约、API 用法、完整示例代码) | 一次性投喂给 AI,或接入上下文知识库 |
本地开发调试时同样可访问:http://localhost:7013/llms.txt。
在 AI 工具中使用
Cursor
- 打开
Settings→Indexing & Docs→Docs→Add doc - 填入
https://udhold.cn/llms-full.txt,保存 - 编码时用
@Docs引用,例如:
@Docs 按 UDhold 插件契约帮我生成一个「待办清单」插件的工程骨架,
包含 plugin.json、Vue 3 入口和一个待办列表页面。
TRAE
- 打开「设置」→「文档集」(或对话输入框的
#Docs上下文) - 添加文档集,URL 填
https://udhold.cn/llms-full.txt - 对话时
#选中该文档集即可引用
Claude Code / Codex 等 CLI 编码代理
在项目(或全局)的 AGENTS.md / 规则文件里加一行指引,代理会在开发 UDhold 插件前主动抓取文档:
## UDhold 插件开发
开发 UDhold 插件相关代码前,先读取 https://udhold.cn/llms-full.txt 了解
plugin.json 契约、权限模型与设计系统,再动手写代码。
网页版 AI 对话(Claude / ChatGPT 等)
- 支持联网的模型:直接把
https://udhold.cn/llms-full.txt链接发给它,让它基于文档回答 - 不联网的模型:先打开 llms.txt 找到相关章节,把对应文档页内容粘贴进对话
其他工具
任何支持 llms.txt 标准或 URL 摄取的工具(知识库、RAG 管道、IDE 插件等)都可以直接使用上面两个地址,无需额外适配。
让 AI 写出能跑的插件
投喂文档只是第一步,提问方式决定产出质量:
- 先文档后代码:让 AI 先通读 llms-full.txt 再动手,避免它按 uTools 或浏览器扩展的旧经验瞎编 API
- 点明两件事:宿主方法统一返回
IpcResult信封(失败不抛异常,要检查code);敏感能力必须在plugin.json的permissions里声明 - 要完整骨架:让 AI 按「目录结构 → plugin.json → package.json → 入口文件」的顺序输出,与快速上手的工程结构对齐,生成后可直接进宿主调试
延伸阅读
- llmstxt.org:llms.txt 标准规范
- 快速上手:跟着文档走一遍完整开发流程