结合Cursor使用
本文将介绍如何结合Cursor使用本文档，并对llms.txt协议进行详细说明。
OpenAPI文档站支持llms.txt协议，既可供用户直接查阅，也可无缝对接各类支持该协议的工具进行使用。
1. 在Cursor中使用本文档
1.1 配置文档数据源
配置Cursor的@Docs数据源，可以很方便地将本文档集成到Cursor中使用。
1.2 使用方法
在配置完成后，您可以直接在Cursor中访问和使用本文档的内容。
2. llms.txt协议详解
2.1 协议背景
llms.txt是一种新兴的Web标准，旨在帮助大型语言模型（LLMs）更有效地访问和理解网站内容。通过在网站根目录下创建llms.txt文件，网站所有者可以为AI系统提供清晰的导航和指引，从而提升信息检索的效率。
2.2 文件结构
llms.txt文件采用Markdown格式，通常包含以下部分：
- 标题：网站名称或项目名称
- 描述（可选）：对网站或项目的简要介绍
- 详细信息（可选）：提供更多背景信息或链接到其他文档
- 章节：列出网站的重要部分，每个部分包含链接和可选的详细说明
示例内容：
# openapi
## Docs
- [创建语音转文本请求](https://docs.openapi.cn/api-reference/audio/create-audio-transcriptions): Creates an audio transcription.
- [创建文本转语音请求](https://docs.openapi.cn/api-reference/audio/create-speech): 从输入文本生成音频。
- [删除参考音频](https://docs.openapi.cn/api-reference/audio/delete-voice): 删除用户预置音色
- [上传参考音频](https://docs.openapi.cn/api-reference/audio/upload-voice): 上传用户预置音色
- [参考音频列表获取](https://docs.openapi.cn/api-reference/audio/voice-list): 获取用户预置音色列表
2.3 文件作用
2.3.1 /llms.txt
- 提供AI友好的导航：该文件提供了整个文档导航的简化视图，使Cursor或ChatGPT等LLM可以更轻松地索引您的内容
- 作为AI的SEO工具：用户可以直接通过通用的LLM找到特定产品的信息
2.3.2 /llms-full.txt
- 完整文档编译：将所有文档文本编译成一个标记符文件
- 上下文集成：便于AI工具基于该文件将信息直接载入其上下文窗口
- 智能建议：可以让AI编码助手根据产品具体细节提供上下文感知建议
2.4 与现有标准的区别
虽然llms.txt与其他Web标准在功能上有所重叠，但各自具有不同的用途：
- robots.txt：用于指示搜索引擎爬虫哪些页面可以或不可以抓取，主要关注访问权限控制
- sitemap.xml：提供网站的结构地图，帮助搜索引擎了解网站的页面布局，主要用于索引目的
- llms.txt：为大型语言模型提供结构化的内容概述，帮助AI系统更好地理解和处理网站信息，提升与AI交互的效果
3. 在其他工具中使用
其他支持llms.txt协议的平台也可以直接使用本文档，例如在ChatGPT中使用。