
Vibe Code Your AI Agent - Lua is built for AI-assisted development. Use Cursor, Windsurf, GitHub Copilot, or any AI coding IDE to build, test, and deploy agents fast.
Connect Your AI IDE to Lua Docs
Get instant access to Lua documentation directly in your coding environment via MCP (Model Context Protocol).Connect to Cursor
One-click install - Click to add Lua docs to Cursor
Connect to VS Code
Add
https://docs.heylua.ai/mcp to your MCP serversManual MCP Setup (Cursor, VS Code, Claude, etc.)
Manual MCP Setup (Cursor, VS Code, Claude, etc.)
Add this to your MCP configuration:MCP Server URL:
https://docs.heylua.ai/mcpWorks with: Cursor, VS Code, Claude, Windsurf, and any MCP-compatible tool.AI Agent Building Guide
Complete workflow for AI IDEs - Authentication, testing strategies, sandbox vs production, common gotchas, and the full build-test-deploy cycle optimized for Cursor, Windsurf, and GitHub Copilot.
What is Lua?
Lua is a developer platform for building AI agents that integrate with your entire business. Write TypeScript functions that connect to any API - your CRM, payment processor, inventory system, or any third-party service - and Lua transforms them into conversational AI capabilities. Your customers chat naturally (βWhereβs my order?β or βBook me a tableβ), and your AI agent takes real actions by calling the functions you wrote.Vibe Coding Ready
Built for AI IDEs - Cursor, Windsurf, GitHub CopilotAll commands are non-interactive. Let AI write your agent.
Integrate With ANY API
Your Backend - CRM, ERP, databasesExternal Services - Stripe, Shopify, SendGrid
TypeScript-Native
Full type safety with Zod validationLive reload, testing, instant deployment
Two Powerful Products
- π οΈ Lua CLI
- π¬ LuaPop Widget
Build AI agents with custom capabilities using TypeScriptThe development framework for creating AI skills that connect to your APIs.
What You Get
- TypeScript framework for building tools
- Live reload development environment
- Optional Platform APIs (Products, Baskets, Orders, Vector Search, Templates)
- 30+ working examples
- One-command deployment
Quick Start
Explore Lua CLI
Build your first AI agent in 5 minutes
How It Works
Test with Interactive Chat
Chat with your agent to test everything worksSelect sandbox mode to test with your local skills
Testing Individual Tools: Need to test a specific tool with exact inputs? Use
lua test to test tools one at a time. For most development, lua chat is faster for testing complete workflows.v3.0.0: Beyond Skills and Tools
The v3.0.0 release adds powerful new capabilities beyond basic skills and tools:LuaAgent
Unified Configuration - Configure your entire agent in one placeCombines persona, skills, webhooks, jobs, and processors
LuaWebhook
HTTP Endpoints - Receive events from external servicesStripe payments, Shopify orders, GitHub deployments, etc.
LuaJob
Scheduled Tasks - Automate recurring operationsDaily reports, cleanup jobs, monitoring with cron patterns
Jobs API
Dynamic Scheduling - Create jobs from tools at runtimeUser reminders, follow-ups, deferred work
PreProcessor
Message Filtering - Process messages before your agentSpam detection, profanity filters, routing, validation
PostProcessor
Response Formatting - Enhance responses after generationDisclaimers, branding, translation, formatting
Complete v3.0.0 Example
Complete Flexibility: Choose Your Integration Approach
One of Luaβs core strengths is flexibility. You can integrate with your existing systems, use our optional Platform APIs, or mix both approaches. Hereβs how each approach works:- Your APIs Only
- Platform APIs
- Mix Both (Recommended)
100% Custom Integration
Connect directly to your existing backend, databases, and third-party services. This gives you complete control over your business logic, data, and infrastructure.- Existing infrastructure and systems
- Custom business requirements
- Enterprise integrations
- Any industry or use case
- Complete control over data and logic
- CRM: Salesforce, HubSpot, your custom CRM
- E-commerce: Shopify, WooCommerce, Magento, your custom store
- ERP: SAP, Oracle, your internal systems
- Payments: Stripe, PayPal, Square, your payment gateway
- Databases: PostgreSQL, MongoDB, MySQL, your data warehouse
Detailed Integration Examples
Example 1: Pure Custom - CRM Integration
Connect to your existing CRM system (Salesforce, HubSpot, or custom):Example 2: Platform APIs - Quick E-commerce
Build an e-commerce assistant using Platform APIs:Example 3: Hybrid - Real Business Solution
Combine your systems with Platform helpers:Real-World Use Cases
Lua can power AI agents for virtually any industry or use case. Here are some common scenarios:E-commerce
Shopping Assistant
- Product search and recommendations
- Cart management and checkout
- Order tracking and updates
- Customer support and FAQs
Customer Support
24/7 AI Support Agent
- Ticket creation and management
- Knowledge base search
- Order lookups and status updates
- Escalation to human agents
SaaS Products
In-App AI Assistant
- User onboarding and tutorials
- Feature guidance and help
- Account management
- Usage analytics and insights
Internal Tools
AI-Powered Operations
- Access ERP, CRM, and databases
- Generate reports and analytics
- Automate workflows
- Data lookups and updates
Finance & Banking
Account Management
- Balance inquiries and transfers
- Transaction history
- Payment processing
- Report generation
Healthcare
Patient Portal Assistant
- Appointment scheduling
- Prescription lookups
- Doctor directory search
- Health record access
HR & Recruiting
Employee Assistant
- Policy and benefits search
- Leave requests and approvals
- Onboarding support
- Document access
Logistics
Shipping & Tracking
- Multi-carrier tracking
- Shipping quotes and labels
- Delivery status updates
- Route optimization
Why Developers Love Lua
π€ Vibe Coding Ready
π€ Vibe Coding Ready
Built for AI-assisted development. All CLI commands are non-interactive, meaning Cursor, Windsurf, GitHub Copilot, and other AI coding tools can execute commands directly. Connect docs via MCP for instant context. Build agents faster with AI helping you code.
π No Vendor Lock-In
π No Vendor Lock-In
Build on your own infrastructure. Integrate with any API you choose. Not tied to our Platform APIs - theyβre completely optional. Your data stays with your systems, your authentication remains yours.
β‘ Fast Development
β‘ Fast Development
Live reload during development means instant feedback. TypeScript autocomplete guides you. Test your agent with
lua chat immediately. Deploy with one command. Build in minutes what would take days with other platforms.π― Full Control
π― Full Control
Your code, your logic, your data. Complete control over authentication, business rules, error handling, and integrations. Not limited by platform constraints - if you can code it in TypeScript, you can build it.
π Production Ready
π Production Ready
Version management built-in. Sandbox for testing before production. Environment variables for secrets. One-command deployment. Monitoring and logs. Everything you need for enterprise production use.
π οΈ Real Developer Tools
π οΈ Real Developer Tools
Actual TypeScript code, not YAML configs or no-code builders. Zod validation for type-safe inputs. Proper testing with
lua test and lua chat. Modern dev workflow you already know.π Optional Platform Helpers
π Optional Platform Helpers
Platform APIs available when you need quick e-commerce or vector search. But theyβre completely optional - use them or donβt, itβs your choice. Most developers use a hybrid approach.
Platform Architecture
Understanding how Lua works helps you build better agents:Skills and Tools
Tools are TypeScript classes that implementLuaTool:
- Each tool performs one specific action
- Tools have names, descriptions, and input schemas
- The AI decides when to call each tool based on context
- Group tools that work together
- Each skill can have multiple tools
- Skills can be versioned and deployed independently
Development Workflow
Testing Strategies
Interactive Testing (lua chat):
- Best for testing complete workflows
- Chat naturally and see tools called in real-time
- Choose sandbox mode to test local code before deploying
- Fast iteration during development
lua test):
- Test specific tools with exact inputs
- Useful for debugging edge cases
- Validates schemas and error handling
- Good for automated testing
Security and Best Practices
Environment Variables
Always use environment variables for API keys and secrets:Error Handling
Implement proper error handling in your tools:Input Validation
Use Zod schemas for type-safe validation:Feature Highlights
Any API
REST, GraphQL, WebSockets - integrate with anything callable from TypeScript
TypeScript
Full type safety with autocomplete and IntelliSense
Live Reload
Instant feedback during development with auto-recompilation
Optional Platform APIs
Ready-to-use helpers for e-commerce and vector search
Voice Chat
Voice interactions built into LuaPop widget
One-Command Deploy
Production deployment in seconds
Get Started
π€ AI Agent Building Guide
For Cursor, Windsurf, Copilot - Complete workflow for AI IDEsNon-interactive commands, testing strategies, deploymentβ Best for vibe coding
π οΈ Quick Start Tutorial
Lua CLI - Create AI agents that integrate with your APIsInstall CLI, write TypeScript tools, deploy instantlyβ 5 minute quick start
π¬ Add Chat Widget
LuaPop Widget - Embed AI chat on your websiteOne script tag, fully customizable, works anywhereβ 2 minute setup
π Connect Docs to Your IDE
MCP Server - Get Lua docs in Cursor, VS Code, ClaudeOne-click install for instant documentation accessβ Scroll up for setup
Learning Path
Understand Core Concepts
Learn how Lua enables AI agents to take real actions through your code
Skills and Tools
Build Your First Agent
Follow a complete tutorial from installation to deployment
First Skill Tutorial
Explore Integration Options
See examples of external APIs, Platform APIs, and hybrid approaches
API Integration Guide
Deploy to Production
Add the chat widget to your website and go live
Chat Widget Setup
Popular Resources
Quick Start Guide
Get your first AI agent running in 5 minutes
API Integration
Learn how to integrate with your APIs or use Platform APIs
Complete API Reference
Full documentation for all classes and methods
30+ Working Examples
External APIs, Platform APIs, and hybrid approaches
CLI Commands
Complete command reference and workflows
Chat Widget Setup
Add AI chat to your website in 2 minutes
Featured Demos
See complete, production-ready implementations:E-commerce Assistant
Complete shopping experience with cart and checkoutUses: Platform APIs (Products, Baskets, Orders)
Customer Support
Zendesk integration with AI knowledge baseUses: Zendesk API + Platform Data (vector search)
Financial Onboarding
KYC verification with document uploadUses: Stripe Identity + Platform Data
HR Assistant
Employee management and policy searchUses: BambooHR + Platform Data
Logistics Tracker
Multi-carrier shipping (UPS, FedEx, USPS)Uses: Multiple external APIs
View All 11 Demos
Customer-facing and internal agent solutionsSee: Complete code for all use cases
Enterprise Features
Security
Token-based auth, HTTPS only, secure environment variables, session isolation
Scalability
Auto-scaling infrastructure, CDN delivery, WebSocket optimization
Compliance
GDPR ready, SOC 2 compliant, data residency options, audit logs
Support
Technical support, migration assistance, dedicated success team
Need Help?
Discord Community
Chat with other builders and get real-time help
Documentation
Complete guides and tutorials
Support
Email our team
Ready to Build Your First Agent?
Complete quick start tutorial with step-by-step instructions β

