LLMs-txt 概览

LLMs-txt 概览

概览

以下是 llms.txt 格式的文档文件列表,特别是 llms.txtllms-full.txt。这些文件允许大语言模型(LLM)和智能体访问编程文档和 API,在集成开发环境(IDE)中特别有用。

语言版本llms.txtllms-full.txt
LangGraph Pythonhttps://langchain-ai.github.io/langgraph/llms.txthttps://langchain-ai.github.io/langgraph/llms-full.txt
LangGraph JShttps://langchain-ai.github.io/langgraphjs/llms.txthttps://langchain-ai.github.io/langgraphjs/llms-full.txt
LangChain Pythonhttps://python.langchain.com/llms.txt不适用
LangChain JShttps://js.langchain.com/llms.txt不适用

:::info[审查输出]

即使能够访问最新的文档,当前最先进的模型也可能不总是能生成正确的代码。请将生成的代码作为起点,在部署到生产环境之前始终进行审查。

llms.txtllms-full.txt 的区别

  • llms.txt 是一个索引文件,包含带有内容简要描述的链接。LLM 或智能体必须跟随这些链接才能访问详细信息。

  • llms-full.txt 将所有详细内容直接包含在一个文件中,无需额外导航。

使用 llms-full.txt 时的一个关键考虑因素是其大小。对于大量文档,此文件可能会变得太大而无法放入 LLM 的上下文窗口。

通过 MCP 服务器使用 llms.txt

截至 2025 年 3 月 9 日,IDE 尚未对 llms.txt 提供健壮的原生支持。但是,您仍然可以通过 MCP 服务器有效地使用 llms.txt

🚀 使用 mcpdoc 服务器

我们提供了一个专为 LLM 和 IDE 提供文档的 MCP 服务器

👉 langchain-ai/mcpdoc GitHub 仓库

此 MCP 服务器允许将 llms.txt 集成到 CursorWindsurfClaudeClaude Code 等工具中。

📘 仓库中提供了设置说明和使用示例。

使用 llms-full.txt

LangGraph 的 llms-full.txt 文件通常包含数十万个 token,超过大多数 LLM 的上下文窗口限制。要有效地使用此文件:

  1. 使用 IDE(例如 Cursor、Windsurf)

    • llms-full.txt 添加为自定义文档。IDE 将自动对内容进行分块和索引,实现检索增强生成(RAG)。
  2. 没有 IDE 支持时

    • 使用具有大上下文窗口的聊天模型。
    • 实施 RAG 策略以高效管理和查询文档。
On this page

On this page