SurrealDB llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/surrealdb/llms-txt) # SurrealDB llms.txt Browse SurrealDB documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools. surrealdb.com/llms.txt [Raw llms.txt](https://surrealdb.com/llms.txt) [Raw llms-full.txt](https://surrealdb.com/llms-full.txt) Copy Markdown [](https://surrealdb.com/llms.txt) llms.txt Platform SurrealDB SurrealDB features SurrealDB documentation SurrealDB Cloud Surrealist Surrealist Surrealist web app Surrealist documentation SurrealQL SurrealQL documentation SurrealQL statements SurrealQL functions Documentation Documentation home What is SurrealDB? Installation SurrealQL reference SurrealQL statements SurrealQL functions CLI reference REST API reference SurrealDB Cloud management Get started with SurrealDB Cloud Deploy on SurrealDB Cloud Surrealist docs SurrealML docs Spectron docs SDK documentation Integrations docs Tutorials Labs Querying What is SurrealQL? Writing SurrealQL Statements and values Executing queries Via CLI Via HTTP Via SDKs Via Surrealist GraphQL Sample queries Via HTTP Via Surrealist Via Bruno Bulk operations and data import Connecting from serverless & edge Custom functions Error handling Idempotent operations Parameterised queries Query optimisation Sequences Sessions and scoping Subqueries and advanced patterns Testing Transactions Working with types Managing APIs Middleware Live queries Changefeeds Real-time best practices Performance best practices Schema management Schema design Schema best practices Schema evolution Sample industry schemas Tables Fields and validation Record IDs and addressing Record ID best practices Index types and strategies Namespace & database architecture Defining events Reactive patterns Computed fields Closures Working with files Buckets Data models Document model Schema modes Nested objects and arrays Common patterns Graph model Creating relations Graph traversal Record links vs graph relations Recursive traversals Knowledge graph patterns Social network patterns Full-text search model Search indexes Analyzers and tokenizers Scoring and ranking Other ways to work with text Vector search model Vector indexes Similarity search Hybrid search Embedding pipelines RAG architecture patterns Geospatial model Geometry types Spatial queries Distance and proximity Location-based patterns Time-series model Using SurrealDB as a time series database Time buckets and windowing Aggregation queries IoT and telemetry patterns Security Introduction Users Summary Tokens & JWTs Permissions & row-level security Capabilities Security best practices Troubleshooting Extensions Surrealism plugins Quick tutorial Further examples Using WASM plugins Creating custom modules Module architecture Surrealism attribute reference Products SurrealDB SurrealDB Cloud Surrealist Spectron Spectron get started SurrealDS Extensions SurrealDB University Enterprise Open source AI and agent tools Sidekick MCP Server Agent Skills Spectron Getting started Install SurrealDB SurrealDB quick start Get started with SurrealDB Cloud Get started with JavaScript SDK Get started with Python SDK Get started with Rust SDK Get started with Go SDK Get started with Java SDK Get started with .NET SDK Get started with PHP SDK SDKs JavaScript / TypeScript SDK Python SDK Rust SDK Go SDK Java SDK .NET SDK PHP SDK C SDK Use cases AI agents Agent memory Knowledge graphs Real-time applications Embedded and edge Customer stories Samsung Verizon Tencent PolyAI Permit.io Saks SiteForge DigitalKin Aspire Calamu Fountain GameScript LiveSponsors Yaacomm Industry solutions Finance and fintech Healthcare Gaming and entertainment Retail and ecommerce Defence and aerospace Energy and manufacturing SurrealDB Cloud SurrealDB Cloud Cloud documentation Deploy on SurrealDB Cloud Cloud getting started Pricing Resources Blog Pricing SurrealDB vs MongoDB SurrealDB vs PostgreSQL SurrealDB vs Neo4j Learn Releases Roadmap Integrations Benchmarks Events Labs Why SurrealDB The context layer vs Vector databases vs Memory middleware vs Agent databases vs Data platforms vs Traditional databases Community GitHub Discord YouTube LinkedIn X / Twitter Reddit Stack Overflow Company Contact Careers Brand assets Legal Trust Centre Status ## What is SurrealDB's llms.txt? SurrealDB 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 SurrealDB offers and where to find details. Issues Spec 17 Sections 220 Links 29.1 KB Size ~7.4k Tokens Sections: Platform · SurrealDB · Surrealist · SurrealQL · Documentation · Products · and 11 more ## Add SurrealDB Docs to Your AI Assistant Select your tool to see how to add SurrealDB'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://surrealdb.com/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about SurrealDB Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 5 errors ## Frequently Asked Questions Where is SurrealDB's llms.txt file? SurrealDB publishes its llms.txt at https://surrealdb.com/llms.txt. This file provides a structured, markdown-formatted index of SurrealDB's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use SurrealDB'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 SurrealDB's documentation so it can provide better code suggestions and answers about SurrealDB. What does SurrealDB's llms.txt contain? SurrealDB's llms.txt contains 17 sections and 220 documentation links in 29.1 KB (~7.4k tokens). Key sections include Platform, SurrealDB, Surrealist, SurrealQL, Documentation, Products. How many tokens does SurrealDB's llms.txt use? The concise llms.txt index is approximately 7.4k tokens (29.1 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 SurrealDB? Last updated: 2026-02-21. SurrealDB'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 SurrealDB. 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 [Liam ERD Automatically generates beautiful and easy-to-read ER diagrams from your database.](https://mdream.dev/llms-txt/surrealdb/llms-txt/liam) [PixiJS Documentation for LLMs PixiJS is the fastest, most lightweight 2D library available for the web, working across all devices and allowing you to create rich, interactive graphics and cross-platform applications using WebGL and WebGPU.](https://mdream.dev/llms-txt/surrealdb/llms-txt/pixijs-documentation-for-llms) [Remix - Ethereum IDE Remix IDE documentation - develop, test and deploy Ethereum smart contracts.](https://mdream.dev/llms-txt/surrealdb/llms-txt/remix-ide) [SpacetimeDB SpacetimeDB is a fully-featured relational database system that integrates](https://mdream.dev/llms-txt/surrealdb/llms-txt/spacetimedb) [Browser Use Browser Use is a cloud platform and open-source SDK that enables AI agents to autonomously interact with websites using natural language. It provides web agents, stealth browser infrastructure, custom LLMs optimized for browser automation, managed proxies, and skills that turn any website into a reliable API endpoint.](https://mdream.dev/llms-txt/surrealdb/llms-txt/browser-use) [PixiJS Documentation for LLMs PixiJS is the fastest, most lightweight 2D library available for the web, working across all devices and allowing you to create rich, interactive graphics and cross-platform applications using WebGL and WebGPU.](https://mdream.dev/llms-txt/surrealdb/llms-txt/pixijs) [Durable Execution Solutions | Temporal](https://mdream.dev/llms-txt/surrealdb/llms-txt/durable-execution-solutions-temporal) [TOON Token-Oriented Object Notation](https://mdream.dev/llms-txt/surrealdb/llms-txt/toon) [View all 99 projects ](https://mdream.dev/llms-txt/surrealdb/llms-txt) ## Related Tools [

llms.txt Generator

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

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/surrealdb/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)