LLMs.txt

View source
Use the @movk/core llms.txt endpoint to give large language models a concise, structured map of the library's functions and documentation.

What is LLMs.txt?

LLMs.txt is a structured documentation format designed for large language models (LLMs). @movk/core provides LLMs.txt files containing comprehensive information about the utility library, enabling AI tools to better understand and assist with @movk/core development.

These files are optimized for AI consumption and contain structured information about function signatures, API parameters, usage patterns, and best practices.

Available Endpoints

We provide LLMs.txt endpoints to help AI tools access our documentation:

  • /llms.txt — A structured overview of all functions with links to their documentation (~5K tokens)
  • /llms-full.txt — Full documentation including implementation details, examples, type definitions, and best practices (100K+ tokens)

Choosing the Right File

Most users should start with /llms.txt — it contains all essential information and fits within a standard LLM context window. Only use /llms-full.txt if you need complete implementation examples and your AI tool supports a large context (200K+ tokens).

Important Usage Notes

The @ symbol must be typed manually — when using tools like Cursor or Windsurf, you must type the @ symbol directly in the chat interface. Copying and pasting will break the tool's ability to recognize it as a context reference.

How to Use with AI Tools

Any AI tool that supports LLMs.txt can use these endpoints to better understand @movk/core.

Copyright © 2024 - 2026 YiXuan - MIT License