# Replay Documentation

Canonical URL: https://docs.replay.io/

Replay QA is an autonomous app testing tool built on Replay's time-travel
debugging engine. Point it at a web app and it explores the application,
builds user journeys through it, runs them while capturing full runtime
recordings, and delivers root cause analysis for every bug it finds.

## Use Replay QA (for coding agents)

Each link below describes itself; read it instead of relying on prior knowledge.

Default: run the CLI skill. Use the REST API or MCP server only when the CLI cannot run.

- Test-and-fix workflow: run `npx --yes replayqa@latest skill` and follow the
  workflow it prints.
- REST API: https://qa.replay.io/api/v1/openapi.json — every endpoint, field,
  bug status, and the intended agent loop.
- MCP server: `https://qa.replay.io/api/mcp` (streamable HTTP) — tools via MCP
  `tools/list`; client setup in
  [Driving Replay QA from a coding agent](https://docs.replay.io/basics/replay-qa/agent-integration).
- Credentials: [API keys and tokens](https://docs.replay.io/reference/api-keys)
- Agent skills:
  [Fix a QA-reported GitHub issue](https://qa.replay.io/api/v1/skills/fix-qa-bug/SKILL.md),
  [Replay QA GitHub App](https://qa.replay.io/api/v1/skills/github-app/SKILL.md)
- Missing a capability? Tell the Replay team on Discord: https://www.replay.io/discord

## Documentation

This documentation site is the canonical reference for Replay QA. Start here:

- [Replay QA overview](https://docs.replay.io/basics/replay-qa/overview)
- [How Replay QA models your app](https://docs.replay.io/basics/replay-qa/concepts)
  — projects, explorations, journeys, test runs, bugs, polish passes, versions, recordings
- [Getting good results](https://docs.replay.io/basics/replay-qa/getting-good-results)
  — instructions, design document, logins, scope, budget, pauses, working the bug list
- [Testing a localhost app](https://docs.replay.io/basics/replay-qa/localhost)
- [Testing a pull request build in GitHub Actions](https://docs.replay.io/basics/replay-qa/frpc-ci)
- [Continuous QA from GitHub](https://docs.replay.io/basics/replay-qa/github)
  — GitHub App, main-branch and PR testing modes, PR comment and check, issue trackers
- [Publishing with source maps](https://docs.replay.io/basics/replay-qa/source-maps)
- [Driving Replay QA from a coding agent](https://docs.replay.io/basics/replay-qa/agent-integration)
  — REST API and MCP server for the full create-project → read-bugs → mark-fixed loop
- [Replay QA API and MCP tools](https://docs.replay.io/reference/replay-qa/api),
  [Polish passes](https://docs.replay.io/reference/replay-qa/polish-passes),
  [Bug reports](https://docs.replay.io/reference/replay-qa/bug-reports) — reference
- [Guides section index](https://docs.replay.io/basics)

Replay QA is built on Replay's recording and time-travel debugging engine. The
same engine is available directly to developers and their coding agents:

- [Debugging with Replay](https://docs.replay.io/basics/debugging/overview)
  — overview of the record → investigate workflow and how it relates to Replay QA.
- [Replay MCP](https://docs.replay.io/basics/replay-mcp/overview) — an MCP
  server (`https://dispatch.replay.io/nut/mcp`) that lets an AI agent inspect
  a recording: sources, console, network, user interactions, React renders and
  performance, Redux / Zustand / TanStack Query state, Playwright steps, and
  execution over time. The page covers setup for Claude Code, Cursor, VS Code,
  and Codex. [Tools reference](https://docs.replay.io/reference/replay-mcp/tools)
  lists all 30 tools; agents call `RecordingOverview` first.
- [How to record](https://docs.replay.io/basics/getting-started/record-your-app)
  — make a recording of your own app with the `replayio` CLI, then open it in
  Replay DevTools (https://app.replay.io) or hand it to your agent through MCP.
- [How time travel works](https://docs.replay.io/reference/time-travel/how-does-time-travel-work)
- [Reference section index](https://docs.replay.io/reference) — CLI commands,
  source maps, API keys, public APIs.

## Machine-readable surfaces

- `/.well-known/api-catalog` — RFC 9727 catalog of Replay APIs (linkset+json)
- `/.well-known/mcp/server-card.json` — Replay MCP server card
- `/.well-known/agent-skills/index.json` — Replay agent skills (Replay CLI,
  Playwright, MCP)
- `/.well-known/openid-configuration` — OAuth/OIDC discovery for the Replay
  authentication tenant
- `/sitemap.xml` — URL inventory for the public documentation
- `/robots.txt` — crawl + AI-bot policy with `Content-Signal`

## Content usage

This documentation may be indexed for search and used as grounding context for
AI agents (`Content-Signal: search=yes, ai-input=yes, ai-train=no`). It must
not be ingested into model training corpora.

## Contact

- Product site: https://www.replay.io
- Replay QA: https://qa.replay.io
- App: https://app.replay.io
- Discord: https://www.replay.io/discord
- GitHub: https://github.com/replayio