Egg llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/egg/llms-txt) # Egg llms.txt Browse Egg documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools. eggjs.org/llms.txt [Raw llms.txt](https://eggjs.org/llms.txt) [Raw llms-full.txt](https://eggjs.org/llms-full.txt) Copy Markdown [](https://eggjs.org/llms.txt) llms.txt Table of Contents Advanced Ajv 入参校验 AOP 中间件 AOP 切面编程 Application Startup Configuration Assets BackgroundTask 异步任务 Basic Behind a Proxy Build RESTful API Bundle Deployment Code Style Guide Common Errors Community Config 配置 Configuration Contribution Guide Controller Controller Cookie and Session Cookie 与 Session Core Dependency Injection Deployment Directory Structure Egg and Koa Egg.js 与 Koa Egg.js 是什么 Egg@2 Upgrade guideline Egg@2 升级指南 EventBus 消息中枢 Exception Handling Extend EGG Framework Built-in Objects Framework Development Frequently Asked Questions HTTP Controller HTTP Controller HttpClient HttpClient I18n Internationalization Koa 中间件 Loader Local Development Logger MCP Controller Middleware Mock Helpers ( @eggjs/mock / mm ) Multi-Process Development Model Enhancement Multi-Process Model and Inter-Process Communication MySQL MySQL Passport Passport Plugin Plugin Development Progressive Development Quick Start Redis Redis Router Runtime Environment Schedule Controller Schedule Controller 定时任务 Security Sequelize Sequelize Service Snapshot Troubleshooting Socket.IO Socket.IO Startup Manifest TEGG_EGG_PROTO_NOT_FOUND TEGG_EGG_PROTO_NOT_FOUND TEGG_ROUTER_CONFLICT TEGG_ROUTER_CONFLICT Tutorials TypeScript TypeScript Unit Testing Unit Testing Untitled Untitled Upgrade your event functions in your lifecycle V8 Startup Snapshot V8 启动快照 View Plugin Development View Template Rendering View 插件开发 View 模板渲染 What is Egg? 代码风格指南 依赖注入 前置代理模式 加载器（Loader） 升级你的生命周期事件函数 单元测试 单元测试 启动清单（Startup Manifest） 启动自定义 国际化（I18n） 基础功能 多进程模型和进程间通讯 多进程研发模式增强 安全 实现 RESTful API 对象生命周期 常见错误 常见问题 应用部署 异常处理 快照故障排查 快速入门 打包部署 插件 插件开发 教程 日志 服务（Service） 本地开发 核心功能 框架内置基础对象 框架开发 框架扩展 测试 Mock 工具（@eggjs/mock / mm） 渐进式开发 目录结构 社区 路由（Router） 运行环境 进阶 静态资源 ## What is Egg's llms.txt? Egg publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what Egg offers and where to find details. Pass Spec 1 Sections 132 Links 5.9 KB Size ~1.4k Tokens Sections: Table of Contents ## Add Egg Docs to Your AI Assistant Select your tool to see how to add Egg's llms.txt as a documentation source. Cursor Windsurf Claude Code ChatGPT Zed Copilot 1. 1 Open any chat or composer panel 2. 2 Type @Docs and select "Add new doc" 3. 3 Paste the URL: https://eggjs.org/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about Egg Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 135 notes ## Frequently Asked Questions Where is Egg's llms.txt file? Egg publishes its llms.txt at https://eggjs.org/llms.txt. This file provides a structured, markdown-formatted index of Egg's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use Egg's llms.txt with AI coding assistants? Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of Egg's documentation so it can provide better code suggestions and answers about Egg. What does Egg's llms.txt contain? Egg's llms.txt contains 1 sections and 132 documentation links in 5.9 KB (~1.4k tokens). Key sections include Table of Contents. How many tokens does Egg's llms.txt use? The concise llms.txt index is approximately 1.4k tokens (5.9 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline. What is Egg? Born to build. Egg's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with Egg. Can I generate an llms.txt for my own project? Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator. ## Browse More llms.txt Files [Elastic Documentation Elastic provides an open source search, analytics, and AI platform, and out-of-the-box solutions for observability and security. The Search AI platform combines the power of search and generative AI to provide near real-time search and analysis with relevance to reduce your time to value.](https://mdream.dev/llms-txt/egg/llms-txt/elastic) [Browserless.io Documentation Browserless.io provides headless browser automation as a service with APIs for browser automation, PDF generation, screenshots, and more, with a focus on bypassing bot detection systems.](https://mdream.dev/llms-txt/egg/llms-txt/browserless) [Gogs: A painless self-hosted Git service Gogs is a painless self-hosted Git service](https://mdream.dev/llms-txt/egg/llms-txt/gogs) [OpenAI API docs Guides and conceptual documentation for building with the OpenAI API.](https://mdream.dev/llms-txt/egg/llms-txt/platform) [Font Awesome Docs Official documentation for Font Awesome icons.](https://mdream.dev/llms-txt/egg/llms-txt/font-awesome) [Easy!Appointments Online Appointment Scheduler](https://mdream.dev/llms-txt/egg/llms-txt/easy-appointments) [Convoy The Cloud Native Webhooks Gateway](https://mdream.dev/llms-txt/egg/llms-txt/convoy) [FalkorDB Ultra-fast, Multi-tenant Graph Database](https://mdream.dev/llms-txt/egg/llms-txt/falkordb) [View all 99 projects ](https://mdream.dev/llms-txt/egg/llms-txt) ## Related Tools [

llms.txt Generator

Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/egg/tools/llms-txt/generator) [

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/egg/tools/llms-txt/validator) © 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license) [GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)