This page provides documentation files optimized for Large Language Models (LLMs) and AI coding assistants. These files help AI tools understand and work with the Luzmo platform more effectively.
LLMs can make mistakes. While these resources help AI tools generate better Luzmo integration code, always review and test AI-generated code before using it in production. We are continuously updating these files based on feedback to improve accuracy and cover more use cases.
| File | Description | Best For |
|---|---|---|
| llms.txt | High-level overview with links to detailed docs | Quick context, general questions |
| llms-api.txt | Core API: entities, CRUD, data queries, permissions | Backend integration, API calls |
| llms-flex.txt | Flex SDK: 46+ chart types, slots, options, filters | Frontend visualizations |
| AGENTS.md | Security rules, patterns, code templates | AI code generation (Cursor, Copilot) |
The llms.txt format is an open standard for AI-readable documentation. It provides structured information about the Luzmo platform that AI assistants (like ChatGPT, Claude, Perplexity) can use to better understand and answer questions about Luzmo.
AGENTS.md is a specification for AI coding assistants (like Cursor, GitHub Copilot, Codex). It contains setup instructions, code patterns, and best practices specifically designed to help AI coding tools generate correct Luzmo integration code.
You can reference these files when asking AI assistants about Luzmo:
"Using the documentation at developer.luzmo.com/assets/llm-resources/llms-api.txt, how do I create an embed token?"
"Based on developer.luzmo.com/assets/llm-resources/llms-flex.txt, show me how to create a column chart"
For tools like Cursor or GitHub Copilot:
Download the AGENTS.md file
Place it in your project root directory
The AI coding assistant will automatically use it for context
Alternatively, you can reference the files directly:
Add to your project's .cursorrules or similar configuration
Reference the URL in your prompts
| File | URL |
| llms.txt | https://developer.luzmo.com/assets/llm-resources/llms.txt |
| llms-api.txt | https://developer.luzmo.com/assets/llm-resources/llms-api.txt |
| llms-flex.txt | https://developer.luzmo.com/assets/llm-resources/llms-flex.txt |
| AGENTS.md | https://developer.luzmo.com/assets/llm-resources/AGENTS.md |
Platform overview
API endpoints (EU, US, VPC)
SDK package names and installation commands
Chart type list
Quick links to documentation
Complete SDK setup for all languages (Node.js, Python, PHP, Java, C#)
All API actions (create, get, update, delete, associate, dissociate)
All API entities with examples
Data query syntax with filter expressions
Error handling
Frontend SDK setup for all frameworks (React, Angular, Vue, Web Components)
All 46+ chart types with slot configurations
Complete options reference
Filter syntax
Component methods and events
Cross-chart filtering
Security rules (critical for AI code generation)
Common integration patterns
Quick reference templates
Environment variable setup
Error handling patterns
These files are designed to improve AI-assisted development with Luzmo. If you have suggestions for improvements or find that AI tools are generating incorrect code, please let us know at support@luzmo.com .