{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs-realm.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"redocly_category":"Realm","type":"markdown"},"seo":{"title":"Make docs AI ready","description":"OpenAPI-generated documentation tool with 24k+ stars on Github - make APIs your company's superpower.","siteUrl":"https://redocly.com","image":"/assets/redocly-card.f670aae34a39545a5ea633a540cb3a4a333a1f23bb2ed3c4a1b17a5fbcf0ac85.db81178d.png","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"make-docs-ai-ready","__idx":0},"children":["Make docs AI ready"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your readers no longer arrive only through a browser."," ","They ask AI assistants questions, and their agents query your documentation directly."," ","Realm serves both: it answers questions inside your site, and it exposes your content to external AI tools in formats they consume."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"answer-questions-inside-your-site","__idx":1},"children":["Answer questions inside your site"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Readers ask a question and get an answer grounded in your documentation."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/ai-assistant"},"children":["AI assistant configuration"]}]}," - Enable and configure the AI assistant on your site"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/ai-assistant-web-component/ai-assistant-web-component"},"children":["AI assistant web component"]}]}," - Embed the assistant in your own applications outside the docs site"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"serve-your-docs-to-agents","__idx":2},"children":["Serve your docs to agents"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["External AI agents and coding assistants connect to your documentation and query it as a data source."," ","Realm also creates an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["llms.txt"]}," file for your site."," ","It lists your pages and links a clean Markdown copy of each, in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://llmstxt.org"},"children":["llmstxt.org"]}," format that LLM tools read."," ","For a real one, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://redocly.com/llms.txt"},"children":["Redocly's llms.txt"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/customization/agent-skills"},"children":["Agent skills"]}]}," - Package task instructions that agents load on demand"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/seo#llmstxt-object"},"children":["llms.txt configuration"]}]}," - Set the file's title, description, and sections, or turn it off"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/customization/mcp-server"},"children":["MCP servers"]}]}," - Serve your documentation and APIs over the Model Context Protocol"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/content/api-docs/openapi-extensions/x-mcp"},"children":["x-mcp extension"]}]}," - Control how API operations appear to MCP clients"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/navigation#pageaction-object"},"children":["Page actions"]}]}," - Copy or view any page as Markdown, ask ChatGPT or Claude about it, or connect an editor to your MCP server"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":3},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/faq/ai-governance"},"children":["AI governance FAQ"]}]}," - Answers for security and compliance reviews of Redocly AI features"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/search-and-seo"},"children":["Tune search and SEO"]}]}," - Help people and search engines find your documentation"]}]}]},"headings":[{"value":"Make docs AI ready","id":"make-docs-ai-ready","depth":1},{"value":"Answer questions inside your site","id":"answer-questions-inside-your-site","depth":2},{"value":"Serve your docs to agents","id":"serve-your-docs-to-agents","depth":2},{"value":"Resources","id":"resources","depth":2}],"frontmatter":{"seo":{"title":"Make docs AI ready"}},"lastModified":"2026-08-26T22:04:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/realm/ai-ready","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}