Apollo GraphQL llms.txt · AI Docs Browser · mdream

[llms.txt Tools](https://mdream.dev/llms-txt/apollo-graphql/llms-txt)

# Apollo GraphQL llms.txt

Browse Apollo GraphQL documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools.

www.apollographql.com/llms.txt

[Raw llms.txt](https://www.apollographql.com/llms.txt) [Raw llms-full.txt](https://www.apollographql.com/llms-full.txt)

Copy Markdown [](https://www.apollographql.com/llms.txt)

llms.txt

Docs > Products > Apollo GraphOS Platform

Apollo GraphOS Quickstart

Platform Limits

Docs > Products > Apollo GraphOS Platform > APIs and Tools

The GraphOS Platform API

Apollo Sandbox

Docs > Products > Apollo GraphOS Platform > APIs and Tools > GraphOS MCP Server

Install GraphOS MCP Server

GraphOS MCP Server Tools

Docs > Products > Apollo GraphOS Platform > Schema Management

GraphOS Schema Management

Docs > Products > Apollo GraphOS Platform > Schema Management > Schema Delivery > Publishing

Publishing Schemas to GraphOS

Publish Schemas to GraphOS using Rover

Publish Schemas to GraphOS using the Platform API

Schema publishing with GitHub Actions

Docs > Products > Apollo GraphOS Platform > Schema Management > Schema Delivery

Launches

Docs > Products > Apollo GraphOS Platform > Schema Management > Schema Delivery > Graph Artifacts

Graph Artifacts

Deploy with Graph Artifacts

Tags

OCI Registry

Self-host Graph Artifacts

Docs > Products > Apollo GraphOS Platform > Schema Management > Schema Delivery > Contracts

Contracts Overview

Creating and Using Contracts

Contracts Usage Patterns

Contract Reference

Docs > Products > Apollo GraphOS Platform > Schema Management > Schema Checks

Schema Checks

Run Schema Checks

Run Custom Schema Checks

Check Configurations

Connecting Apollo to GitHub

Schema Checks Reference

Docs > Products > Apollo GraphOS Platform > Schema Management > Schema Linting

Schema Linting

Schema Linter Rules

Docs > Products > Apollo GraphOS Platform > Schema Management > Schema Proposals

Schema Proposals

Schema Proposal Configurations

Propose Schema Changes

Review Schema Proposals

Implement Approved Proposals

Docs > Products > Apollo GraphOS Platform > Explorer IDE

GraphOS Studio Explorer

Connecting and Authenticating with the Explorer

Operation Collections

GraphQL Subscription Support

Embedding the Explorer

Custom Scripts in the Explorer

Additional Explorer Features

Docs > Products > Apollo GraphOS Platform > Graph Security

Graph Security

Safelisting with Persisted Queries

Docs > Products > Apollo GraphOS Platform > Metrics and Insights

GraphOS Metrics and Insights

Docs > Products > Apollo GraphOS Platform > Metrics and Insights > Metrics Collection and Forwarding

Sending Metrics to GraphOS

Operation Signatures

Forwarding Metrics to Datadog

Docs > Products > Apollo GraphOS Platform > Metrics and Insights > Insights and Analysis

Operation Metrics in GraphOS

Field Usage in GraphOS

Error Diagnostics in GraphOS

Subgraph Metrics in GraphOS

Segmenting Metrics by Client

Docs > Products > Apollo GraphOS Platform > Metrics and Insights > Notifications and Alerts

GraphOS Notifications and Alerts

Daily Reports from GraphOS

Schema Change Notifications

Schema Proposals Notifications

Performance Alerts from GraphOS

Build Status Notifications

Docs > Products > Apollo GraphOS Platform > Access Management

GraphOS Organizations

Members, Roles, and Permissions

Export and Read Audit Logs

Docs > Products > Apollo GraphOS Platform > Access Management > API Keys

API Keys

Graph API Keys

Subgraph API Keys

Personal API Keys

Operator API Keys

Manage API Keys with GraphOS Studio

Manage API Keys with the Platform API

Docs > Products > Apollo GraphOS Platform > Access Management > SSO

GraphOS Single Sign-On

Multi-organization SSO

Docs > Products > Apollo GraphOS Platform > Access Management > SSO > SAML

Set up SAML SSO with Okta

Set up SAML SSO with Microsoft Entra ID (formerly Azure AD)

Set up SSO with a SAML-based IdP

Docs > Products > Apollo GraphOS Platform > Access Management > SSO > OIDC

Set up OIDC SSO with Okta

Set up OIDC SSO with Microsoft Entra ID (formerly Azure AD)

Set up SSO with an OIDC-based IdP

Docs > Products > Apollo GraphOS Platform > Access Management > SCIM

SCIM Provisioning Overview

Set up SCIM with Okta

Set up SCIM with Microsoft Entra ID

Docs > Products > Apollo GraphOS Platform > Graph Management

Add and Manage Variants

Add a Subgraph

Manage Subgraphs

Updating Graph Components

Transfer graphs

Docs > Products > Apollo GraphOS Platform > Production Readiness

Production Readiness Checklist

Docs > Products > Apollo GraphOS Platform > Production Readiness > Testing and Load Management

Overload Protection

Load Testing a Federated GraphQL API

Testing with Apollo Federation

Docs > Products > Apollo GraphOS Platform > Production Readiness > Environment and Deployment

Graph Environment Best Practices

Deploying API Changes with GraphOS

Keeping Schemas Up-To-Date in Client Apps

Deployment Best Practices

Docs > Products > Apollo Connectors

Why use Apollo Connectors?

Troubleshooting Connectors

Docs > Products > Apollo Connectors > Getting Started

Apollo Connectors Quickstart

REST API Requirements

Version Requirements

Docs > Products > Apollo Connectors > Connectors Library

Connectors Library

Docs > Products > Apollo Connectors > Connectors Library > Prebuilt Connectors

Anthropic Connector

OpenAI Connector

AWS DynamoDB Connector

AWS Lambda Connector

Strapi Connector

Stripe Connector

OData Connector

Docs > Products > Apollo Connectors > Development and Tooling

Connectors Development Workflow and Tooling

IDE Support for Connectors Development

Using Rover for Connectors Development

CLI Tools for Connectors

Connectors Mapping Playground

Docs > Products > Apollo Connectors > Making Requests

Making HTTP Requests

Building Request URLs

Setting HTTP Request Headers

Setting HTTP Request Bodies

Batch Requests

Connecting gRPC services using a JSON Bridge

Docs > Products > Apollo Connectors > Handling Responses

Mapping HTTP Responses

Mapping Response Fields

Error Handling with Connectors

Docs > Products > Apollo Connectors > Working with Entities

Working with Entities

Entity Resolution Patterns

Working with Entities Across Subgraphs

Docs > Products > Apollo Connectors > Mapping Language

Mapping Language Overview

Mapping Arrays

Mapping Enums

Using Literal Values

Abstract Types

Virtual Connectors

Mapping Variable Reference

Mapping Methods Reference

Docs > Products > Apollo Connectors > Deployment

Connectors Deployment Overview

Runtime Configuration Overview

Docs > Products > Apollo Connectors > Deployment > Deployment Configurations

Overriding Base URLs

Overriding Headers

Docs > Products > Apollo Connectors > Deployment > Security Configurations

Connectors Security Configurations

Connectors Authentication Configuration

Connectors Request Limit Configuration

Connectors TLS Configuration

Docs > Products > Apollo Connectors > Deployment > Performance Configurations

Connectors Performance Overview

Connectors Traffic Shaping Configuration

Docs > Products > Apollo Connectors > Deployment > Observability

Connector Observability

Connector Telemetry Configuration

Docs > Products > Apollo Connectors > Testing

Connectors Testing Framework

Docs > Products > Apollo Connectors > Connectors Reference

Apollo Connectors Changelog

Apollo Connectors Preview Features

Apollo Connectors Directives

Limitations of Apollo Connectors

Docs > Products > Apollo Federation > Federated Schemas

Introduction to Apollo Federation

Federated Schemas

Schema Composition

Value Types in Apollo Federation

Docs > Products > Apollo Federation > Federated Schemas > Federation Reference

Apollo Federation Changelog

Apollo Federation Directives

Composition Rules

Docs > Products > Apollo Federation > Federated Schemas > Federation Reference > Subgraph Reference

Apollo Federation Subgraph Specification

Subgraph Specific Fields

Federation-Compatible Subgraph Implementations

Docs > Products > Apollo Federation > Federated Schemas > Federation Reference > Development and Tooling

Query Plans

Composition Hints

Apollo Federation Error Codes

Docs > Products > Apollo Federation > Federated Schemas > Federation Reference > From Federation 1 to 2

Moving to Apollo Federation 2

Backward Compatibility in Apollo Federation 2

Docs > Products > Apollo Federation > Entities

Introduction to Entities

Docs > Products > Apollo Federation > Entities > Entity Essentials

Contribute and Reference Entity Fields

Define Advanced Keys

Entity Interfaces

Docs > Products > Apollo Federation > Entities > Entity Guides

Thinking in Entities

Migrate Entity and Root Fields

Resolve another subgraph's fields

Enforcing Entity Ownership in Apollo Federation

Use contexts to share data

Docs > Products > Apollo Federation > Schema Design Guides > Schema Design Principles

Demand Oriented Schema Design

Schema Naming Conventions

Namespacing by Separation of Concerns

Docs > Products > Apollo Federation > Schema Design Guides > Schema Design Principles > Server-Driven UI

Server-Driven UI Basics

Server-Driven UI Schema Design

Server-Driven UI Client Design

Docs > Products > Apollo Federation > Schema Design Guides > Data Handling Techniques

Handling the N+1 Problem

Nullability

Recommended Usage for GraphQL Interfaces

Designing Response Types

Errors as Data Explained

Aggregating Data Across Subgraphs

Graph Identities

Docs > Products > Apollo Federation > Schema Design Guides > Schema Development and Evolution

Mocking to Unblock Development

Schema Deprecations

Mutation Management with Apollo Federation

Moving a GraphQL Monolith to Apollo Federation

Migrating from Schema Stitching

Docs > Products > Apollo Federation > Schema Design Guides > Federated Directives

Choosing the Right Directive

Using the @shareable Directive

Using the @provides Directive

Docs > Products > Rover CLI

The Rover CLI

Installing Rover

Configuring Rover

Using Rover with a Proxy Server

Using Rover in CI/CD

Rover Conventions

Privacy and Data Collection

Contributing to Rover

Rover CLI Error Codes

Docs > Products > Rover CLI > Commands

Rover API Key Commands

Rover client commands

Rover completion Commands

Rover config Commands

Rover connector Commands

Rover contract Commands

The Rover dev Command

The Rover explain Command

Rover install Command

Rover graph Commands

The Rover graph-artifact Command

The Rover init Command

The Rover license Command

The Rover persisted-queries Command

Rover README Commands

Rover schema commands

Rover subgraph Commands

Rover supergraph Commands

Rover template Commands

Docs > Products > Rover CLI > The Apollo CLI (deprecated)

The Apollo CLI

Validating Client Operations

Migrating to Rover

Docs > Products > Apollo Router

Apollo Router Quickstart

Router Request Lifecycle

Docs > Products > Apollo Router > Configuration

Router Configuration Overview

Hot Reload

Router Environment Variable Configuration Reference

Router CLI Configuration Reference

Router YAML Configuration Reference

Docs > Products > Apollo Router > Features > Security

Supergraph Security with GraphOS Router

Safelisting with Persisted Queries

Authorization in the GraphOS Router

Configuring CORS

Cross-Site Request Forgery (CSRF) Prevention

TLS

Request Limits

Demand Control

Docs > Products > Apollo Router > Features > Security > Authentication

JWT Authentication in the GraphOS Router

Authenticating Requests with the GraphOS Router

Subgraph Authentication

Docs > Products > Apollo Router > Features > Observability > Studio Insights

GraphOS Observability Overview

GraphOS reporting

Federated Trace Data

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL)

Router Telemetry

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > Telemetry Data > Metrics

Instruments

Router Instruments

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > Telemetry Data

Events

Conditions

Selectors

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > Telemetry Data > Traces

Spans

OpenTelemetry standard attributes

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > Telemetry Data > Usage Guides > Subgraph Observability

Subgraph Error Inclusion

Debugging Subgraph Requests from the GraphOS Router or @apollo/gateway

OpenTelemetry in Apollo Federation

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > Telemetry Data > Usage Guides > Client Observability

Debugging Client Requests to GraphOS Router

Client Awareness and Enforcement

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > Telemetry Exporters > Metrics Exporters

Metrics exporters

OpenTelemetry Protocol (OTLP) exporter

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > Telemetry Exporters > Log Exporters

Router Logging

Router Logging to stdout

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > Telemetry Exporters > Trace Exporters

Router Tracing

OpenTelemetry Protocol (OTLP) exporter

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > APM Guides > Datadog

Datadog Integration

Router Instrumentation for Datadog

Dashboard Template for Datadog

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > APM Guides > Datadog > Connecting to Datadog

Connecting to Datadog

Connect to Datadog via OpenTelemetry Collector

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > APM Guides > Datadog > Connecting to Datadog > Datadog Agent

Datadog configuration of OTLP exporter

Datadog configuration of OTLP exporter

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > APM Guides > New Relic

New Relic configuration of OTLP exporter

New Relic configuration of OTLP exporter

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > APM Guides > Prometheus

Prometheus exporter

Connecting OpenTelemetry Traces to Prometheus

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > APM Guides > Zipkin

Zipkin tracing

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > APM Guides > Jaeger

Jaeger configuration of OTLP exporter

Docs > Products > Apollo Router > Features > Observability > Router Telemetry (OTEL) > APM Guides > Dynatrace

Dynatrace configuration of OTLP exporter

Dynatrace configuration of OTLP exporter

Docs > Products > Apollo Router > Features > Performance and Scaling

Performance and Scaling

Traffic Shaping

Query Batching

Circuit Breaking

Docs > Products > Apollo Router > Features > Performance and Scaling > Response Caching

Response Caching

Response Caching Quickstart

Invalidation

Response Cache Customization

Response Cache Observability

Response Caching FAQ

Docs > Products > Apollo Router > Features > Client Features

Automatic Persisted Queries (APQ)

Header Propagation

@defer Directive Support

File uploads

Docs > Products > Apollo Router > Features > Client Features > GraphQL Subscriptions

Overview of GraphQL Subscription Support

Configure GraphQL Subscription Support

HTTP Callback Protocol for GraphQL Subscriptions

Multipart HTTP protocol for GraphQL Subscriptions

Enabling HTTP Subscriptions with the GraphOS Router and an API Gateway

Docs > Products > Apollo Router > Features > Client Features > GraphQL Subscriptions > HTTP Callback Best Practices

HTTP Callback Subscriptions Best Practices

Subscription Broker Pattern

Guaranteed Delivery Pattern

Docs > Products > Apollo Router > Features > Query Planning

Native Query Planner

Best Practices for Query Planning

Query Plan Caching

Docs > Products > Apollo Router > Features > Customization

Router Customizations

Docs > Products > Apollo Router > Features > Customization > Coprocessors

External Coprocessing

Coprocessor Reference

Docs > Products > Apollo Router > Features > Customization > Rhai Scripts

Rhai Scripts to customize routers

Rhai Script API Reference

Docs > Products > Apollo Router > Features > Customization > Custom Builds

Creating a Custom Apollo Router Core Binary

Writing Native Rust Plugins

Docs > Products > Apollo Router > Deployment

Self-Hosting the Apollo Router

HTTP proxy configuration

Docs > Products > Apollo Router > Deployment > Docker

Deploying the Apollo Runtime in Docker

Deploying only GraphOS Router in Docker

Docs > Products > Apollo Router > Deployment > Kubernetes

Kubernetes Quickstart

Router Extensibility Features in Kubernetes

Enabling Metrics Endpoints

Considerations for Hosting the Router in Kubernetes

Docs > Products > Apollo Router > Deployment > AWS

Deploying GraphOS Router on AWS

Docs > Products > Apollo Router > Deployment > Azure

Deploying GraphOS Router on Azure

Docs > Products > Apollo Router > Deployment > GCP

Deploying GraphOS Router on GCP

Docs > Products > Apollo Router > Deployment > Managed Hosting

Deploying GraphOS Router on Railway

Deploying GraphOS Router on Render

Docs > Products > Apollo Router > Deployment > Tools

Router Resource Estimator

Health Checks

Managing GraphOS Router Resources in Kubernetes

Docs > Products > Apollo Router > Releases

Apollo Router Changelogs

What's New in GraphOS Router v2.x

Upgrading from Versions 1.x

Gateway Migration Guide

Does GraphOS Router Replace My API Gateway?

Docs > Products > Apollo Router > GraphOS Integration

GraphOS Router License

Licensed GraphOS Router Features

Apollo Uplink

Docs > Products > Apollo Router > Reference

Federation Version Support

Router Errors

Docs > Products > Apollo Operator

Apollo GraphOS Operator

Changelog

Security Best Practices

Docs > Products > Apollo Operator > Getting Started

Install Apollo GraphOS Operator

Add Subgraphs

Deploy a Supergraph

Docs > Products > Apollo Operator > Kubernetes Resources > Supergraph

Supergraph resources

Autoscaling your Supergraphs

Migrating from the Router Helm Chart

Supergraph podTemplate

Supergraph networking

Docs > Products > Apollo Operator > Kubernetes Resources > Supergraph > Safe Deployments

Safe Deployments

Advanced Safe Deployments

Docs > Products > Apollo Operator > Kubernetes Resources

SupergraphSchema resources

SupergraphSet resources

Subgraph resources

Docs > Products > Apollo Operator > Workflows

Workflows

Single Cluster Setup

Multi-Cluster and Hybrid Setup

Deploy Only Setup

Docs > Products > Apollo Operator > Configuration

Configuration

Telemetry Configuration

Controllers Configuration

OCI Configuration

Private Registry Configuration

Docs > Open source > Apollo Client (Web)

Introduction to Apollo Client

Why Apollo Client?

Get started with Apollo Client

Migrating to Apollo Client 4.0

Docs > Open source > Apollo Client (Web) > Core concepts

Queries

Suspense

Fragments

Mutations in Apollo Client

TypeScript with Apollo Client

Refetching queries in Apollo Client

Event-based refetching

Subscriptions

Using GraphQL directives in Apollo Client

Handling operation errors

Persisted queries

Document transforms

Using the @defer directive in Apollo Client

GraphQL query best practices

Docs > Open source > Apollo Client (Web) > Caching

Caching in Apollo Client

Configuring the Apollo Client cache

Reading and writing data to the cache

Garbage collection and cache eviction

Customizing the behavior of cached fields

Memory management

Advanced topics on caching in Apollo Client

Docs > Open source > Apollo Client (Web) > Pagination

Pagination in Apollo Client

Core pagination API

Offset-based pagination

Cursor-based pagination

Key arguments in Apollo Client

Docs > Open source > Apollo Client (Web) > Local State

Managing local state

Local-only fields in Apollo Client

Reactive variables

Local resolvers

Docs > Open source > Apollo Client (Web) > Development & Testing

Developer tools

GraphQL Codegen

Testing React components

Schema-driven testing

Mocking schema capabilities

Reducing bundle size

Docs > Open source > Apollo Client (Web) > Performance

Improving performance in Apollo Client

Optimistic mutation results

Server-side rendering

Compiling queries with Transpilers

Docs > Open source > Apollo Client (Web) > Integrations

View integrations

Next.js App Router

React Router framework mode

TanStack Start

Integrating with React Native

Loading queries with Webpack

Docs > Open source > Apollo Client (Web) > Networking

Basic HTTP networking

Advanced HTTP networking

Authentication

Docs > Open source > Apollo Client (Web) > API Reference > Core

class ApolloClient

class InMemoryCache

ObservableQuery

Docs > Open source > Apollo Client (Web) > API Reference > Errors

CombinedGraphQLErrors

CombinedProtocolErrors

LinkError

LocalStateError

ServerError

ServerParseError

UnconventionalError

Docs > Open source > Apollo Client (Web) > API Reference > React

ApolloProvider

useQuery

useLazyQuery

useMutation

useSubscription

useFragment

useApolloClient

useReactiveVar

useSuspenseQuery

useBackgroundQuery

useReadQuery

useLoadableQuery

useQueryRefHandlers

skipToken

createQueryPreloader

MockProvider

SSR

Docs > Open source > Apollo Client (Web) > API Reference > Apollo Link

Apollo Link overview

ApolloLink

BaseHttpLink

BaseBatchHttpLink

BatchHttpLink

BatchLink

ClientAwarenessLink

ErrorLink

GraphQLWsLink

HttpLink

PersistedQueryLink

RemoveTypenameFromVariablesLink

RetryLink

SchemaLink

SetContextLink

WebSocketLink

Community links

Docs > Open source > Apollo iOS

Introduction to Apollo iOS

Getting Started with Apollo iOS

Docs > Open source > Apollo iOS > Project Configuration

Project configuration

Project Modularization

Schema Types Configuration

Operation Models Configuration

Docs > Open source > Apollo iOS > Migration Guides

Apollo iOS 2.0 Migration Guide

Docs > Open source > Apollo iOS > Tutorial

Get started with Apollo iOS codegen

Docs > Open source > Apollo iOS > Tutorial > Build a project with Apollo

Introduction

1. Configure your project

2. Add the GraphQL Schema

3. Write your first query

4. Running code generation

5. Execute your first query

6. Connect your queries to your UI

7. Add more info to the list

8. Paginate results

9. Complete the details view

10. Write your first mutation

11. Authenticate your operations

12. Define additional mutations

Docs > Open source > Apollo iOS > Code Generation

Code generation

The Codegen CLI

Codegen configuration

Downloading a schema

Running code generation in Swift code

Code Generation Troubleshooting

Docs > Open source > Apollo iOS > Fetching

Fetching Data

Operation Arguments

Error Handling

Type Conditions

Custom Scalars

Persisted Queries

Using the @defer directive in Apollo iOS

Docs > Open source > Apollo iOS > Fetching > Operations

Queries

Mutations

Subscriptions

Fragments

Docs > Open source > Apollo iOS > Caching

Client-side caching

Cache setup

Direct cache access

Custom cache keys

Programmatic Cache Keys

Docs > Open source > Apollo iOS > Networking

Creating a client

WebSocket transport

Docs > Open source > Apollo iOS > Pagination

Pagination

Using custom response models

Directional Pagination

Multi-Query Pagination

Docs > Open source > Apollo iOS > Development & Testing

Test mocks

Using Apollo as an XCFramework

Docs > Open source > Apollo iOS > Advanced

File uploads

Request chain customization

Client Directives

Docs > Open source > Apollo Kotlin

Introduction to Apollo Kotlin

Migrating to Apollo Kotlin 5

Modules

Evolution policy

Docs > Open source > Apollo Kotlin > Configuration

Gradle plugin configuration

Gradle plugin recipes

Multi Modules codegen

GraphQL file types in Apollo Kotlin

Client Awareness

Docs > Open source > Apollo Kotlin > Fetching

Queries in Apollo Kotlin

Mutations in Apollo Kotlin

Subscriptions in Apollo Kotlin

Using GraphQL variables in Apollo Kotlin

Error handling

Custom scalar types in Apollo Kotlin

Fragments in Apollo Kotlin

Using the @defer and @stream directives in Apollo Kotlin

Persisted queries

Docs > Open source > Apollo Kotlin > Caching

Caching in Apollo Kotlin

Normalized caches in Apollo Kotlin

Declarative cache IDs in Apollo Kotlin

Programmatic cache IDs in Apollo Kotlin

Watching cached data

ApolloStore

Expiration management with the normalized cache

Garbage collection

The normalized cache compiler plugin

Partial cache reads

Options

Performance of the normalized cache

Cache migration guide

HTTP cache

Troubleshooting

Docs > Open source > Apollo Kotlin > Caching > Pagination

Pagination support in the normalized cache

Relay-style pagination

Other types of pagination

Managing pagination manually

Docs > Open source > Apollo Kotlin > Networking

Interceptors

Using a custom HTTP client

Using the models without apollo-runtime

Authenticate your operations

Batching operations

Docs > Open source > Apollo Kotlin > Development & Testing

Testing in Apollo Kotlin

Mocking HTTP responses (experimental)

Mocking GraphQL responses

Data builders

Android Studio / IntelliJ plugin

Apollo Debug Server

Docs > Open source > Apollo Kotlin > Advanced

Uploading files

Handling Networks Errors

Handling nullability and partial data

Using aliases

Using Java

Apollo AST

Apollo compiler plugins

JS Interoperability

Response based codegen

Apollo Kotlin galaxy

Docs > Open source > Apollo Server

Introduction to Apollo Server

Get Started with Apollo Server

Docs > Open source > Apollo Server > New in v4 and v5

Migrating from Apollo Server 4

Migrating from Apollo Server 3

Previous Versions of Apollo Server

Docs > Open source > Apollo Server > Defining a Schema

GraphQL Schema Basics

Unions and Interfaces

Custom Scalars

Directives

Docs > Open source > Apollo Server > Resolving Operations

Resolvers

Context and contextValue

Error Handling

Subscriptions in Apollo Server

Docs > Open source > Apollo Server > Fetching Data

Fetching Data

Fetching from REST

Docs > Open source > Apollo Server > Web Frameworks

Apollo Server Integrations

Building Web Framework Integrations for Apollo Server

Teaching the MERN Stack to Speak GraphQL

Docs > Open source > Apollo Server > Development Workflow

Build and Run Queries Against Apollo Server

Operation Request Format

Generating Types from a GraphQL Schema

Mocking

Integration Testing

Docs > Open source > Apollo Server > Performance

Server-Side Caching

Configuring Cache Backends

Response Cache Eviction

Automatic Persisted Queries

Docs > Open source > Apollo Server > Security

Authentication and Authorization

Configuring CORS

Terminating SSL

Proxy Configuration

Hardening for Production

Docs > Open source > Apollo Server > Deployment

Deploying with AWS Lambda

Deploying with Heroku

Docs > Open source > Apollo Server > Monitoring

Metrics and Logging

Health Checks

Docs > Open source > Apollo Server > API Reference

API Reference: ApolloServer

API Reference: startStandaloneServer

API Reference: expressMiddleware

Docs > Open source > Apollo Server > Plugins

Built-In Plugins

Docs > Open source > Apollo Server > Plugins > Built-in

API Reference: Usage Reporting Plugin

API Reference: Schema Reporting Plugin

API Reference: Inline Trace Plugin

API Reference: Drain HTTP Server Plugin

API Reference: Cache Control Plugin

API Reference: Landing Page Plugins

API Reference: Subscription Callback Plugin

Docs > Open source > Apollo Server > Plugins > Custom

Creating Apollo Server Plugins

Apollo Server Plugin Event Reference

Docs > Open source > Apollo Server > Using with Federation > As a subgraph

Implementing a Subgraph with Apollo Server

API Reference: @apollo/subgraph

Docs > Open source > Apollo Server > Using with Federation > As a gateway

Implementing a Gateway with Apollo Server

Improving Gateway Performance

API Reference: @apollo/gateway

Docs > Open source > Apollo MCP Server

Apollo MCP Server

Apollo MCP Server Quickstart

Define MCP Tools

Define MCP Prompts

Running the Apollo MCP Server

Debugging the MCP Server

Authorization with Apollo MCP Server

OpenTelemetry Integration

Error Handling

Best Practices

Apollo MCP Server Licensing

Limitations

Docs > Open source > Apollo MCP Server > Configuration

Config File Reference

Custom Scalars Configuration

Docs > Open source > Apollo MCP Server > Deployment

Deploy the MCP Server

Health Checks

Configuring CORS for Apollo MCP Server

Docs > Open source > Apollo MCP Server > Rhai Scripting

Rhai Scripting

Lifecycle Hooks

Functions Reference

Docs > Open source > Apollo MCP Server > MCP Apps

MCP Apps Overview

MCP Apps Prerequisites

MCP Apps Quickstart Guide

MCP Apps Development

MCP Apps Architecture

MCP Apps Reference

Docs > Open source > Apollo MCP Server > Guides

Development to Production Workflows

Authorization with Auth0

Docs > Open source > IDE Support > IDE Support

IDE Support for Graph Development

Graph Development in VS Code

Graph Development in JetBrains IDEs

Graph Development in Vim and NeoVim

Docs > Resources

Apollo Product Changelogs

Apollo Glossary

Apollo Solutions

Use Apollo docs with AI

Docs > Resources > Concepts

Graphs

GraphQL Overview

What is Apollo?

Why Apollo?

Docs > Resources > Guides

Get Started with Apollo

Docs > Resources > Guides > Set up your graph

Define your Use Case

Set up your Apollo Account

Set Up CI/CD

Deploy Apollo Router in Test Environments

Docs > Resources > Guides > Set up your graph > Connect APIs

Choose your Approach

Connect REST APIs

Connect GraphQL APIs (Subgraphs)

Docs > Resources > Guides > Test and deploy to production

Design your Production Schema

Set up your Clients

Deploy your Graph to Production

Migrate Use Case Traffic

Docs > Resources > Guides > GraphQL adoption guides

GraphQL Adoption Patterns

GraphQL as an Abstraction Layer

Supergraph Stewardship

Docs > Resources > Release Policies

Apollo Feature Launch Stages

GraphOS Runtime Release Lifecycle

Apollo Client Library Release Lifecycle

Docs > Resources > Architecture

Reference Architecture

Docs > Resources > Architecture > Supergraph Architecture Framework

Supergraph Architecture Framework

Operational Excellence

Security

Reliability

Performance

Developer Experience

## What is Apollo GraphQL's llms.txt?

Apollo GraphQL 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 Apollo GraphQL offers and where to find details.

Pass

Spec

177

Sections

692

Links

141.2 KB

Size

~36.1k

Tokens

Sections: Docs > Products > Apollo GraphOS Platform · Docs > Products > Apollo GraphOS Platform > APIs and Tools · Docs > Products > Apollo GraphOS Platform > APIs and Tools > GraphOS MCP Server · Docs > Products > Apollo GraphOS Platform > Schema Management · Docs > Products > Apollo GraphOS Platform > Schema Management > Schema Delivery > Publishing · Docs > Products > Apollo GraphOS Platform > Schema Management > Schema Delivery · and 171 more

## Add Apollo GraphQL Docs to Your AI Assistant

Select your tool to see how to add Apollo GraphQL'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://www.apollographql.com/llms.txt
4. 4

   Wait for the green dot (indexing complete)
5. 5

   Reference @Docs in chat when asking about Apollo GraphQL

Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too.

## Spec Compliance 4 notes

## Frequently Asked Questions

Where is Apollo GraphQL's llms.txt file?

Apollo GraphQL publishes its llms.txt at https://www.apollographql.com/llms.txt. This file provides a structured, markdown-formatted index of Apollo GraphQL's documentation that AI systems can consume to understand the project's APIs, guides, and references.

How do I use Apollo GraphQL'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 Apollo GraphQL's documentation so it can provide better code suggestions and answers about Apollo GraphQL.

What does Apollo GraphQL's llms.txt contain?

Apollo GraphQL's llms.txt contains 177 sections and 692 documentation links in 141.2 KB (~36.1k tokens). Key sections include Docs > Products > Apollo GraphOS Platform, Docs > Products > Apollo GraphOS Platform > APIs and Tools, Docs > Products > Apollo GraphOS Platform > APIs and Tools > GraphOS MCP Server, Docs > Products > Apollo GraphOS Platform > Schema Management, Docs > Products > Apollo GraphOS Platform > Schema Management > Schema Delivery > Publishing, Docs > Products > Apollo GraphOS Platform > Schema Management > Schema Delivery.

How many tokens does Apollo GraphQL's llms.txt use?

The concise llms.txt index is approximately 36.1k tokens (141.2 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 Apollo GraphQL?

The GraphQL developer platform. Apollo GraphQL'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 Apollo GraphQL.

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

[unstorage Universal Storage Layer](https://mdream.dev/llms-txt/apollo-graphql/llms-txt/unstorage) [SWR React Hooks for Data Fetching](https://mdream.dev/llms-txt/apollo-graphql/llms-txt/swr) [Wagmi React Hooks for Ethereum](https://mdream.dev/llms-txt/apollo-graphql/llms-txt/wagmi) [Zustand Bear necessities for state management in React](https://mdream.dev/llms-txt/apollo-graphql/llms-txt/zustand) [Remotion Make videos programmatically with React](https://mdream.dev/llms-txt/apollo-graphql/llms-txt/remotion) [Effect A powerful TypeScript library for complex programs](https://mdream.dev/llms-txt/apollo-graphql/llms-txt/effect) [Tiptap The headless rich text editor framework](https://mdream.dev/llms-txt/apollo-graphql/llms-txt/tiptap) [Valibot The modular and type safe schema library](https://mdream.dev/llms-txt/apollo-graphql/llms-txt/valibot)

[View all 99 projects ](https://mdream.dev/llms-txt/apollo-graphql/llms-txt)

## Related Tools

[<h3>llms.txt Generator</h3>Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/apollo-graphql/tools/llms-txt/generator) [<h3>llms.txt Validator</h3>Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/apollo-graphql/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)