@todo fix me!
v1.0.1
  • Get Started
  • Templates
  • GitHub
  • Overview
  • Introduction
  • Installation
  • Vue
  • Nuxt
  • NodeJs
  • UMD
  • AI Tools
  • MCP Server
  • LLMs.txt
  • b24ui
  • b24icons
v1.0.1
  • Docs
  • Frame
  • Hook
  • OAuth
  • Templates

LLMs.txt

How to get AI tools like Cursor, Windsurf, GitHub Copilot, ChatGPT, and Claude to understand Bitrix24 JS SDK methods, tools, and best practices.

What is LLMs.txt?

LLMs.txt is a structured documentation format specifically designed for large language models (LLMs). Bitrix24 JS SDK provides LLMs.txt files that contain comprehensive information about our component library, making it easy for AI tools to understand and assist with Bitrix24 JS SDK development.

These files are optimized for AI consumption and contain structured information about components, APIs, usage patterns, and best practices.

Available Routes

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

  • /llms.txt - Contains a structured overview of all components and their documentation links (~5K tokens)
  • /llms-full.txt - Provides comprehensive documentation including implementation details, examples, theming, composables, and migration guidance (~1M+ tokens)

Choosing the Right File

Most users should start with /llms.txt - it contains all essential information and works with standard LLM context windows.Use /llms-full.txt only if you need comprehensive implementation examples and your AI tool supports large contexts (200K+ tokens).

Important Usage Notes

@-symbol must be typed manually - When using tools like Cursor or Windsurf, the @ symbol must be typed by hand in the chat interface. Copy-pasting breaks the tool's ability to recognize it as a context reference.

Usage with AI Tools

Cursor

Bitrix24 JS SDK provides specialized LLMs.txt files that you can reference in Cursor for better AI assistance with component development.

How to use:

  1. Direct reference: Mention the LLMs.txt URLs when asking questions
  2. Add these specific URLs to your project context using @docs

Read more about Cursor Web and Docs Search

Windsurf

Windsurf can directly access the Bitrix24 JS SDK LLMs.txt files to understand component usage and best practices.

Using LLMs.txt with Windsurf:

  • Use @docs to reference specific LLMs.txt URLs
  • Create persistent rules referencing these URLs in your workspace

Read more about Windsurf Web and Docs Search

Other AI Tools

Any AI tool that supports LLMs.txt can use these routes to better understand Bitrix24 JS SDK.

Examples for ChatGPT, Claude, or other LLMs:

  • "Using Bitrix24 JS SDK documentation from https://bitrix24.github.io/b24jssdk/llms.txt"
  • "Follow complete Bitrix24 JS SDK guidelines from https://bitrix24.github.io/b24jssdk/llms-full.txt"

MCP Server

Use Bitrix24 JS SDK in your AI assistants with Model Context Protocol support.

 

On this page

  • What is LLMs.txt?
  • Available Routes
  • Choosing the Right File
  • Important Usage Notes
  • Usage with AI Tools
    • Cursor
    • Windsurf
    • Other AI Tools
Releases
Published under MIT License.

Copyright © 2024-present Bitrix24