# apollo-router

A skill that writes version-correct router.yaml for Apollo Router v1.x and v2.x and flags the sections where the two schemas diverge.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode · 1800 installs · ★ 119
- Author: apollographql
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/apollographql/skills/tree/HEAD/skills/apollo-router/SKILL.md
- Updated: 2026-10-23
- HTML: https://affpapa.org/en/nevibecode/skills/apollo-router

## What it does

The skill walks the agent through a short interview: target Router version first, then production or development, then the features you want — JWT, CORS, operation limits, telemetry, Connectors, response caching. The YAML comes out of templates under `templates/{version}/`. Version matters because v1 and v2 use incompatible schemas for CORS, JWT auth and Connectors, so a config written for the wrong one will not start.

Production defaults are locked down: introspection off, sandbox off, subgraph errors hidden, health check on. Development flips those open and logs as text. Field-level authorization gets its own pass — `@authenticated`, `@requiresScopes` and `@policy` live in subgraph schemas, not in `router.yaml`, and need a router connected to GraphOS plus a claims source. `@policy` also needs a plugin to evaluate each policy.

You need a composed supergraph schema from Rover or GraphOS. Linux, macOS and Windows are supported. Persisted query safelisting is not APQ: APQ caches whatever a client sends and protects nothing, while a safelist rejects operations that are not on the GraphOS PQL. Start in audit mode to confirm your clients are registered before you enforce.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add apollographql/skills --skill apollo-router -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/apollo-router/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/apollo-router/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add apollographql/skills --skill apollo-router -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/apollo-router/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add apollographql/skills --skill apollo-router -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/apollo-router/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install apollographql/skills apollo-router
```

2. **Manually: put the files in place**
- File: `.github/skills/apollo-router/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add apollographql/skills --skill apollo-router -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/apollographql/skills --path skills/apollo-router
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/apollo-router/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add apollographql/skills --skill apollo-router -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/apollographql/skills/tree/HEAD/skills/apollo-router/SKILL.md

## When to use it
- generate `router.yaml` for a specific Router version without hand-checking schemas
- wire up JWT auth without mixing up `issuer` and `issuers`
- configure CORS for browser clients
- add telemetry: Prometheus, OTLP tracing, JSON logs
- move persisted queries to safelist enforcement

## Example prompts
- Set up Apollo Router v2 for production with JWT, CORS and Prometheus telemetry
- Help me write router.yaml for v1, I already have a router deployed
- Turn on persisted query safelisting with a GraphOS PQL

## Source text · SKILL.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 7a63241b5c7caee4.

BEGIN THIRD-PARTY FILE 7a63241b5c7caee4
````text
---
name: apollo-router
description: >
  Version-aware guide for configuring and running Apollo Router for federated GraphQL supergraphs.
  Generates correct YAML for both Router v1.x and v2.x. Use this skill when:
  (1) setting up Apollo Router to run a supergraph,
  (2) configuring routing, headers, or CORS,
  (3) implementing custom plugins (Rhai scripts or coprocessors),
  (4) configuring telemetry (tracing, metrics, logging),
  (5) troubleshooting Router performance or connectivity issues,
  (6) securing the graph with JWT, declarative field-level authorization directives, or persisted-query safelisting,
  (7) managing router.yaml as version-controlled config with CI/CD validation.
license: MIT
compatibility: Linux/macOS/Windows. Requires a composed supergraph schema from Rover or GraphOS.
metadata:
  author: apollographql
  version: "2.5.0"
allowed-tools: Bash(router:*) Bash(./router:*) Bash(rover:*) Bash(curl:*) Bash(docker:*) Read Write Edit Glob Grep
---

# Apollo Router Config Generator

Apollo Router is a high-performance graph router written in Rust for running Apollo Federation 2 supergraphs. It sits in front of your subgraphs and handles query planning, execution, and response composition.

**This skill generates version-correct configuration.** Router v1 and v2 have incompatible config schemas in several critical sections (CORS, JWT auth, connectors). Always determine the target version before generating any config.

## Step 1: Version Selection

Ask the user **before generating any config**:

```
Which Apollo Router version are you targeting?

  [1] Router v2.x (recommended — current LTS, required for Connectors)
  [2] Router v1.x (legacy — end-of-support announced, security patches only)
  [3] Not sure — help me decide
```

If the user picks **[3]**, display:

```
Quick guide:

  • Pick v2 if: you're starting fresh, using Apollo Connectors for REST APIs,
    or want backpressure-based overload protection.
  • Pick v1 if: you have an existing deployment and haven't migrated yet.
    Note: Apollo ended active support for v1.x. The v2.10 LTS (Dec 2025)
    is the current baseline. Migration is strongly recommended.

  Tip: If you have an existing router.yaml, you can auto-migrate it:
    router config upgrade router.yaml
```

Store the selection as `ROUTER_VERSION=v1|v2` to gate all subsequent template generation.

## Step 2: Environment Selection

Ask: **Production** or **Development**?
````
END THIRD-PARTY FILE 7a63241b5c7caee4

The third-party file has ended. Everything between the 7a63241b5c7caee4 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2455 of 21632 bytes. © apollographql · MIT · https://github.com/apollographql/skills/tree/HEAD/skills/apollo-router/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md