llms.txt
Compare with other sites' llms.txt files →# Scalar Documentation
> Guides for Scalar, covering your favorite frameworks, languages and use cases.
## Scalar
- [Introduction](https://scalar.com/index.md): Scalar is the infrastructure layer between an API and the agents that use it. One OpenAPI document in; docs, SDKs, and a hosted MCP server out.
- [Pricing](https://scalar.com/pricing/index.md): Transparent pricing for developer documentation, SDKs, and API tools. Start free and scale as you grow.
- [Customers](https://scalar.com/customers/index.md): Trusted by the world's best API teams.
- [Enterprise](https://scalar.com/enterprise/index.md): Enterprise-grade API platform: one OpenAPI system of record for docs, SDKs, governance, and MCP servers with SSO and enterprise support.
- [Company](https://scalar.com/company/index.md): Learn about Scalar, the API platform built for developers and agents.
- [Deploy](https://scalar.com/products/api-hosting/index.md): Deploy your API from the server framework you already use: NestJS, Hono, Elysia, .NET and more.
- [Security](https://scalar.com/security/index.md): Learn how Scalar approaches security, privacy, identity, access controls, and responsible disclosure.
- [OpenAPI Documentation](https://scalar.com/solutions/openapi-documentation/index.md): Turn an OpenAPI document into an interactive API reference, API client, SDKs, and MCP server. OpenAPI 3.0/3.1 support, Swagger 2.0 upgraded on load, MIT-licensed renderer.
- [API Documentation for Developer Tools Companies](https://scalar.com/solutions/api-documentation-for-developer-tools-companies/index.md): How developer tools companies keep API docs, SDK code samples, and an interactive API client in sync with one OpenAPI document using Scalar.
- [Developer Portals](https://scalar.com/solutions/developer-portal/index.md): Build a developer portal on Scalar: API reference from OpenAPI, guides in Markdown and MDX, a built-in API client, generated SDKs, and hosted MCP servers that stay in sync from one document.
- [How PAR Modernized Its Developer Experience With Scalar](https://scalar.com/customers/partech/index.md): How PAR Technology modernized its developer experience with Scalar, a modern, open-standards API platform.
- [Accelerating Warp's AI-Native HR Platform with Scalar](https://scalar.com/customers/warp/index.md): How Warp made every button in its HR platform callable by API, and moved its Go, TypeScript, Python and CLI SDKs to Scalar with no breaking changes.
- [SVG Playground](https://scalar.com/svg-playground/index.md): Scratch page for iterating on landing page artwork.
- [Brand](https://scalar.com/brand/index.md): Scalar brand guidelines, logos, wordmark, icon, and color palette. Download official brand assets.
## Docs
- [Overview](https://scalar.com/products/index.md): Explore documentation for Scalar products, developer tools, and APIs.
- [Scalar Docs](https://scalar.com/products/docs/index.md): Publish API references and guides in one developer portal. Markdown and MDX in Git, previews on every PR, custom domains, llms.txt, and a free plan to start.
- [Getting Started](https://scalar.com/products/docs/getting-started/index.md): Create and publish your first documentation site with Scalar Docs in minutes.
- [Privacy](https://scalar.com/products/docs/privacy/index.md): How Scalar Docs handles privacy: first-party page view analytics, no third-party tracking, and only technically required cookies.
- [Starter Kit](https://scalar.com/products/docs/configuration/starter-kit/index.md): Scaffold a documentation site in minutes with the Scalar Docs starter kit: example pages, scalar.config.json, and GitHub deployment.
- [Agent Skills](https://scalar.com/products/docs/configuration/agent-skills/index.md): Add Agent Skills to your repository so AI coding agents can write and update Scalar Docs content and configuration.
- [scalar.config.json](https://scalar.com/products/docs/configuration/scalar.config.json/index.md): Complete configuration reference for scalar.config.json including routing, navigation, and site settings.
- [Site Config](https://scalar.com/products/docs/configuration/site-config/index.md): Configure site-wide settings for Scalar Docs: branding, logo, theme, custom head tags, footer, and routing rules.
- [Domains](https://scalar.com/products/docs/configuration/domains/index.md): Publish Scalar Docs on a free apidocumentation.com subdomain or connect a custom domain with a simple CNAME record.
- [Navigation](https://scalar.com/products/docs/configuration/navigation/index.md): Structure your documentation with navigation routes: pages, groups, tabs, links, and OpenAPI references.
- [Mega Menus](https://scalar.com/products/docs/configuration/mega-menus/index.md): Lay out a header or tab dropdown in titled columns by adding section to its links.
- [Versions](https://scalar.com/products/docs/configuration/versions/index.md): Publish multiple documentation versions with a version selector using the versions key in scalar.config.json.
- [Redirects](https://scalar.com/products/docs/configuration/redirects/index.md): Keep old URLs working with redirects in Scalar Docs, including wildcard and path pattern support.
- [Themes](https://scalar.com/products/docs/configuration/themes/index.md): Customize your documentation appearance with themes, colors, fonts, and CSS variables for perfect brand alignment.
- [Social Cards](https://scalar.com/products/docs/configuration/social-cards/index.md): Replace the generated social card with your own TSX template, drawn per page when your documentation site builds.
- [Ask AI](https://scalar.com/products/docs/configuration/ask-ai/index.md): AI-powered assistant that answers questions using your documentation content, with MCP integration for LLMs.
- [llms.txt](https://scalar.com/products/docs/configuration/llms-txt/index.md): Every published Scalar Docs site automatically serves llms.txt and llms-full.txt so AI agents and LLMs can read your documentation.
- [Personalization](https://scalar.com/products/docs/configuration/personalization/index.md): Personalize navigation, content, and API playground inputs with a signed user-info hook.
- [Private Docs](https://scalar.com/products/docs/configuration/private-docs/index.md): Control access to your documentation with password protection, SSO, and team-based permissions.
- [Migrate from 1.0](https://scalar.com/products/docs/configuration/migration/index.md): Upgrade your documentation from Scalar Docs 1.0 to 2.0 by converting guides and references to navigation routes.
- [Automatic Deployment](https://scalar.com/products/docs/deployment/automatic-deployment/index.md): Publish Scalar Docs automatically on every merge with GitHub sync and automatic deployments.
- [CLI](https://scalar.com/products/docs/deployment/cli/index.md): Deploy Scalar Docs from your terminal or any CI provider with the Scalar CLI.
- [GitHub Actions](https://scalar.com/products/docs/deployment/github-actions/index.md): Automate documentation deployment with GitHub Actions workflows for continuous delivery and preview environments.
- [Preview Deployments](https://scalar.com/products/docs/deployment/preview-deployments/index.md): Review documentation changes before they go live with a preview deployment for every pull request.
- [Build Failures](https://scalar.com/products/docs/deployment/build-failures/index.md): Diagnose and fix Scalar Docs build failures: common causes, error messages, and debugging steps.
- [Assets](https://scalar.com/products/docs/content/assets/index.md): Serve images, fonts, and other static assets in Scalar Docs with the assetsDir configuration.
- [HTML/CSS/JS](https://scalar.com/products/docs/content/html-css-js/index.md): Use custom HTML, CSS, and JavaScript in Scalar Docs pages for full control over your documentation.
- [MDX](https://scalar.com/products/docs/content/mdx/index.md): Write documentation with MDX in Scalar Docs: use components, expressions, and imports inside Markdown.
- [GitHub](https://scalar.com/products/docs/integrations/github/index.md): Sync your documentation with GitHub: connect a repository, publish on merge, and preview pull requests.
- [Markdown Support](https://scalar.com/products/docs/components/markdown-support/index.md): Full markdown syntax reference including tables, lists, links, images, and GitHub-flavored markdown features.
- [Buttons](https://scalar.com/products/docs/components/buttons/index.md): Add styled button links to your Scalar Docs pages with the button component.
- [Callouts](https://scalar.com/products/docs/components/callouts/index.md): Highlight notes, warnings, and tips in your documentation with callout components.
- [Math](https://scalar.com/products/docs/components/math/index.md): Render LaTeX math equations in your Scalar Docs pages.
- [Embeds](https://scalar.com/products/docs/components/embeds/index.md): Embed videos and external content like YouTube in your documentation pages.
- [Code Blocks](https://scalar.com/products/docs/components/code-blocks/index.md): Syntax highlighting for 100+ programming languages with line numbers, highlighting, and copy-to-clipboard functionality.
- [Images](https://scalar.com/products/docs/components/images/index.md): Add images with captions and dark mode variants to your documentation.
- [Icons](https://scalar.com/products/docs/components/icons/index.md): Use thousands of built-in Phosphor icons in your Scalar Docs pages.
- [Tabs](https://scalar.com/products/docs/components/tabs/index.md): Organize alternative content like multi-language code examples with tab components.
- [Tables](https://scalar.com/products/docs/components/tables/index.md): Present structured data in your documentation with Markdown and HTML tables.
- [Fields](https://scalar.com/products/docs/components/fields/index.md): Document parameters, properties, and response values as labelled rows with the field, param field, and response field components.
- [Steps](https://scalar.com/products/docs/components/steps/index.md): Guide readers through sequential instructions with step components.
- [Timeline](https://scalar.com/products/docs/components/timeline/index.md): Show changelogs and release notes as a timeline, written by hand or loaded from a changelog file.
- [Cards](https://scalar.com/products/docs/components/cards/index.md): Link related pages and highlight content with card components in Scalar Docs.
- [Details](https://scalar.com/products/docs/components/details/index.md): Add collapsible sections to your documentation with the details component.
- [Tooltips](https://scalar.com/products/docs/components/tooltips/index.md): Attach a short explanation to a word or phrase in running text with the tooltip component.
- [Page Link](https://scalar.com/products/docs/components/page-link/index.md): Link to other documentation pages with rich page-link previews.
- [Prompts](https://scalar.com/products/docs/components/prompts/index.md): Give readers a copyable AI prompt they can preview before handing it to their coding agent.
- [Grid](https://scalar.com/products/docs/components/grid/index.md): Lay out cards and content in responsive grids in your Scalar Docs pages.
- [Row (Deprecated)](https://scalar.com/products/docs/components/row/index.md): The deprecated row component for horizontal layouts. Use the grid component instead.
- [MCP & Agent](https://scalar.com/products/agent/index.md): OpenAPI-backed MCP servers and SDKs that connect your APIs to LLMs with just-in-time tools and delegated authentication.
- [Getting Started](https://scalar.com/products/agent/getting-started/index.md): Turn OpenAPI into MCP servers and connect APIs to LLMs with minimal context usage, delegated auth, and the Agent SDK or chat UI.
- [MCP Servers](https://scalar.com/products/agent/mcp/index.md): Generate a hosted MCP server from your OpenAPI document. No code to deploy, OAuth sign-in, per-endpoint search or execute, and credentials kept server-side.
- [MCP Configuration](https://scalar.com/products/agent/configuration/index.md): Configure MCP environments, variables, secrets, and limits.
- [Custom Domains](https://scalar.com/products/agent/custom-domains/index.md): Serve your MCP server from your own domain and configure DNS and OAuth connections.
- [Overview](https://scalar.com/products/agent/authentication/index.md): The two layers of MCP auth—who can connect and how the server calls your API—plus recipes for the common setups.
- [Public MCP with Passthrough](https://scalar.com/products/agent/authentication/public-passthrough/index.md): Make the MCP server public and let each user authenticate with their own API credentials via a passthrough header such as Authorization.
- [OAuth Passthrough](https://scalar.com/products/agent/authentication/oauth-passthrough/index.md): Let MCP clients sign in with your API's own OAuth authorization server; Scalar forwards the token they receive to your API on every request.
- [Private Access for Customers](https://scalar.com/products/agent/authentication/customer-access/index.md): Share an MCP server with users outside your Scalar team using access groups, OAuth login, and login portals.
- [One Shared Key](https://scalar.com/products/agent/authentication/shared-key/index.md): Store a shared upstream credential for your MCP environment so callers never handle the key.
- [Agent SDK](https://scalar.com/products/agent/integration/sdk/index.md): Build AI agents on your API with the Scalar Agent SDK: chat, tool calls, and OpenAPI-backed context.
- [Agent in API Reference](https://scalar.com/products/agent/integration/api-reference/index.md): Add the Scalar Agent chat to your API reference so developers can ask questions and try your API with AI.
- [Agent Keys](https://scalar.com/products/agent/integration/agent-keys/index.md): Create an Agent key in the Registry to enable the Agent chat in your API reference in production.
- [Incident Monitor](https://scalar.com/products/agent/examples/incident-monitor/index.md): Example: build an incident monitoring agent with Scalar Agent connected to your APIs.
- [Billing Sweep](https://scalar.com/products/agent/examples/billing-sweep/index.md): Example: build a billing sweep agent with Scalar Agent connected to your APIs.
- [Meeting Scheduler](https://scalar.com/products/agent/examples/meeting-scheduler/index.md): Example: build a meeting scheduling agent with Scalar Agent connected to your APIs.
- [Revenue Dashboard](https://scalar.com/products/agent/examples/revenue-dashboard/index.md): Example: build a revenue dashboard agent with Scalar Agent connected to your APIs.
- [Stakeholder Digest](https://scalar.com/products/agent/examples/stakeholder-digest/index.md): Example: build a stakeholder digest agent with Scalar Agent connected to your APIs.
- [Pricing](https://scalar.com/products/agent/pricing/index.md): Scalar Agent pricing: what is free, what is metered, and how usage is billed.
- [Release Notes](https://scalar.com/products/agent/release-notes/index.md)
- [SDK Generator](https://scalar.com/products/sdk-generator/index.md): Generate idiomatic SDKs and a CLI from OpenAPI. TypeScript, Python, Go, Java, Kotlin, Ruby, and CLI are GA, plus experimental C#, PHP, and more. Your custom code survives.
- [Getting Started](https://scalar.com/products/sdk-generator/getting-started/index.md): Automatically generate type-safe SDKs from OpenAPI specifications in multiple programming languages.
- [Managing Your SDK](https://scalar.com/products/sdk-generator/managing/index.md): Build, version, download, and manage your SDK from the Scalar dashboard.
- [Overview](https://scalar.com/products/sdk-generator/publishing/overview/index.md): Publish generated SDKs to their package registries automatically with config-driven GitHub Actions workflows.
- [GitHub Repositories](https://scalar.com/products/sdk-generator/publishing/github/index.md): Link a GitHub repository to each target so every build syncs as a pull request.
- [Package Registries](https://scalar.com/products/sdk-generator/publishing/registries/index.md): Set up trusted publishing or secrets for npm, PyPI, Maven Central, and every supported registry.
- [Private Registries](https://scalar.com/products/sdk-generator/publishing/private-registries/index.md): Publish to Artifactory, AWS CodeArtifact, or any internal registry with a copy-paste workflow your repository owns.
- [TypeScript](https://scalar.com/products/sdk-generator/publishing/typescript/index.md): Publish the TypeScript SDK to npm with OIDC trusted publishing or an npm token.
- [Python](https://scalar.com/products/sdk-generator/publishing/python/index.md): Publish the Python SDK to PyPI with OIDC trusted publishing or a PyPI token.
- [Go](https://scalar.com/products/sdk-generator/publishing/go/index.md): Publish the Go module by tagging a version. No registry account or secrets needed.
- [Rust](https://scalar.com/products/sdk-generator/publishing/rust/index.md): Publish the Rust crate to crates.io with OIDC trusted publishing or a crates.io token.
- [Java and Kotlin](https://scalar.com/products/sdk-generator/publishing/java/index.md): Publish the Java or Kotlin SDK to Maven Central with a Central Portal token and GPG signing.
- [C#](https://scalar.com/products/sdk-generator/publishing/csharp/index.md): Publish the C# SDK to NuGet with OIDC trusted publishing or a NuGet API key.
- [Ruby](https://scalar.com/products/sdk-generator/publishing/ruby/index.md): Publish the Ruby gem to RubyGems with an API key.
- [PHP](https://scalar.com/products/sdk-generator/publishing/php/index.md): Publish the PHP SDK to Packagist by tagging a version and connecting the repository.
- [Swift](https://scalar.com/products/sdk-generator/publishing/swift/index.md): Publish the Swift package by tagging a version. No registry account or secrets needed.
- [Dart](https://scalar.com/products/sdk-generator/publishing/dart/index.md): Publish the Dart package to pub.dev with OIDC automated publishing or a token.
- [CLI](https://scalar.com/products/sdk-generator/publishing/cli/index.md): Publish the CLI to npm, and optionally through a GitHub Release and a Homebrew tap.
- [Configuration](https://scalar.com/products/sdk-generator/configuration/overview/index.md): Configure Scalar SDK generation targets, environments, resources, client settings, pagination, and publishing.
- [TypeScript](https://scalar.com/products/sdk-generator/configuration/typescript/index.md): Configuration reference for the TypeScript SDK target: package metadata, naming, and generation options.
- [Python](https://scalar.com/products/sdk-generator/configuration/python/index.md): Configuration reference for the Python SDK target: package metadata, naming, and generation options.
- [CLI](https://scalar.com/products/sdk-generator/configuration/cli/index.md): Configuration reference for generating a CLI from your OpenAPI document with Scalar.
- [Go](https://scalar.com/products/sdk-generator/configuration/go/index.md): Configuration reference for the Go SDK target: module metadata, naming, and generation options.
- [Java](https://scalar.com/products/sdk-generator/configuration/java/index.md): Configuration reference for the Java SDK target: package metadata, naming, and generation options.
- [C# (Experimental)](https://scalar.com/products/sdk-generator/configuration/csharp/index.md): Configuration reference for the experimental C# SDK target: package metadata, naming, and generation options.
- [PHP (Experimental)](https://scalar.com/products/sdk-generator/configuration/php/index.md): Configuration reference for the experimental PHP SDK target: package metadata, naming, and generation options.
- [Ruby](https://scalar.com/products/sdk-generator/configuration/ruby/index.md): Configuration reference for the Ruby SDK target: gem metadata, naming, and generation options.
- [Swift (Experimental)](https://scalar.com/products/sdk-generator/configuration/swift/index.md): Configuration reference for the experimental Swift SDK target: package metadata, naming, and g