LLMs.txt

View source
如何让 Cursor、Windsurf、GitHub Copilot、ChatGPT 和 Claude 等 AI 工具理解 @movk/core 函数、最佳实践。

什么是 LLMs.txt?

LLMs.txt 是专为大型语言模型(LLM)设计的结构化文档格式。@movk/core 提供 LLMs.txt 文件,其中包含工具函数库的完整信息,使 AI 工具能够更好地理解和协助 @movk/core 的开发。

这些文件针对 AI 消费进行了优化,包含函数签名、API 参数、使用模式和最佳实践的结构化信息。

可用端点

我们提供 LLMs.txt 端点来帮助 AI 工具访问我们的文档:

  • /llms.txt - 包含所有函数的结构化概览及其文档链接(约 5K tokens)
  • /llms-full.txt - 提供完整文档,包括实现细节、示例、类型定义和最佳实践(100K+ tokens)

选择正确的文件

大多数用户应该从 /llms.txt 开始 - 它包含所有基本信息,适用于标准 LLM 上下文窗口。仅当您需要完整的实现示例且 AI 工具支持大型上下文(200K+ tokens)时,才使用 /llms-full.txt

重要使用说明

@ 符号必须手动输入 - 使用 Cursor 或 Windsurf 等工具时,必须在聊天界面中手动输入 @ 符号。复制粘贴会破坏工具识别它作为上下文引用的能力。

AI 工具使用方法

任何支持 LLMs.txt 的 AI 工具都可以使用这些端点来更好地理解 @movk/core。

Copyright © 2024 - 2026 YiXuan - MIT License