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.
The llms.txt file follows the llmstxt.org format, an open standard for AI-readable documentation. For AI coding assistants (like Cursor, GitHub Copilot, and Codex), we also provide an AGENTS.md file (following open agents.md standard) with setup instructions, code patterns, and best practices for working with Luzmo.
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 | Direct URL |
|---|---|---|---|
| AGENTS.md | Security rules, patterns, code templates. See below how to reference this file in your project. | AI code generation (Cursor, Copilot) | https://developer.luzmo.com/AGENTS.md |
| llms.txt | High-level overview with links to detailed docs. The llms.txt file is also directly referenced inside Luzmo's AGENTS.md file. |
Quick context, general questions | https://developer.luzmo.com/llms.txt |
For tools like Cursor, GitHub Copilot, Claude Code or Codex, put Luzmo-specific guidance in your project's AGENTS.md so it gets picked up and applied automatically by the coding agent. If your project does not have an AGENTS.md , create one. If your tool doesn't use AGENTS.md , you can paste the same section into its rules file (for example .cursorrules or CLAUDE.md ).
Then, add the following section to provide guidance for Luzmo implementations:
## Luzmo (embedded analytics)
When implementing Luzmo functionality (Embed tokens, core API, Flex SDK, or Luzmo IQ), refer to Luzmo's [AGENTS.md](https://developer.luzmo.com/agents.md) file for official best practices and implementation guidelines.You can reference these files directly when asking AI assistants like ChatGPT about Luzmo:
"Using https://developer.luzmo.com/llms.txt , how do I create an embed token?"
AGENTS.mdInstructions file for AI coding assistants working with Luzmo embedded analytics integration. Contains security rules, common patterns, and guidelines to help AI tools generate correct Luzmo code.
Critical security rules (API key handling, embed token usage)
Instructions to fetch relevant documentation before implementing
API design notes (POST-based actions, not REST verbs)
Environment variable setup
Guidelines and best practices when developing with Luzmo
llms.txtComprehensive AI-readable reference for the Luzmo platform, covering the Core API, Flex SDK, and Luzmo IQ.
Platform overview and quick start guide
Backend SDK setup for all languages (Node.js, Python, PHP, Java, C#)
Frontend SDK setup for all frameworks (React, Angular, Vue, Web Components)
Core API documentation URL patterns and resource references
All available Flex chart types
Links to guides for embedding, IQ, and data querying
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 .