# Documentation Agents: start with [Agent quick start](https://www.rystic.ai/docs/agent-quick-start.md). Every page below is Markdown; https://www.rystic.ai/llms-full.txt is all of them in one file. ## Getting started - [Plans and API keys](https://www.rystic.ai/docs/licensing.md) — Free, Pro or Enterprise — what each plan gets you, how an API key signs the CLI in, what a running simulator sends, and what its errors mean. - [Installation](https://www.rystic.ai/docs/installation.md) — From nothing to a running simulator. - [Agent quick start](https://www.rystic.ai/docs/agent-quick-start.md) — Written for the agent, not the human. Install and sign in, run each simulator, hit it, report back. ## Concepts - [Glossary](https://www.rystic.ai/docs/concepts/glossary.md) — One sentence per term these docs use, with the command, route or screen where you meet it. - [Scenarios and seeding](https://www.rystic.ai/docs/concepts/worlds.md) — Named scenarios, the shared design studio, seeding your own records with POST /_rystic/seed, the registers that hold them, rystic describe and the seed gate. - [Reset and determinism](https://www.rystic.ai/docs/concepts/reset-and-determinism.md) — Every boot and every reset starts from the same state. The pinned clock, the fixed RNG seed, pacing and what is and isn't deterministic. - [Observing a simulator](https://www.rystic.ai/docs/concepts/observing.md) — Read a simulator's state, the requests it served, a live event feed and what it would have sent out — from the control plane, rystic tail or the state UI in a browser. ## Guides - [Examples and scripts](https://www.rystic.ai/docs/examples.md) — The MIT-licensed scripts each simulator ships — check.sh, the Kalshi bots, the GitHub review bots and four example stacks — with a run command for each. - [Multi-simulator environments](https://www.rystic.ai/docs/environments.md) — Run several simulators as one project from a rystic.yaml — start and stop them together, move their clocks together, export the stack to Compose. - [Intercept vendor calls](https://www.rystic.ai/docs/intercept.md) — Route an unmodified app's calls for api.stripe.com, slack.com or s3.amazonaws.com to local simulators, with no code change and no base-URL override. - [Webhooks and provider actions](https://www.rystic.ai/docs/webhooks.md) — Test the outbound side of an integration across simulators — signed webhook delivery to your receiver, the egress log, provider actions and timelines. - [Running a shared simulator](https://www.rystic.ai/docs/shared-simulators.md) — One simulator for many clients or agents — lock the control plane with an admin token, log every change and expose it on a network. - [Integration tests in CI](https://www.rystic.ai/docs/integration-testing.md) — Run your integration tests against a simulator in GitHub Actions — one service container, one secret, your existing test runner. - [Kalshi backtesting](https://www.rystic.ai/docs/kalshi-backtesting.md) — Replay captured Kalshi markets through the simulator and run your bot against each tape with rystic batch. - [Slack MCP in Harbor](https://www.rystic.ai/docs/slack-harbor.md) — Connect your Harbor agent to Slack MCP. Get the licensed image, export a task, verify a reply and reset, then attach your own policy and grader. - [Slack Harbor reference run](https://www.rystic.ai/docs/slack-harbor-reference.md) — Run the packaged held-out Slack task with Rystic's reference Harbor harness and a host-side model provider. - [Drive simulators from your coding agent](https://www.rystic.ai/docs/mcp-server.md) — Run rystic mcp so a coding agent starts, seeds, clocks, inspects and diffs simulators, rolls them back to snapshots, saves a scenario file, and saves and checks runs as test cases, through MCP tools. One-command install for Claude Code, Cursor, Codex, VS Code and Windsurf. - [Rystic on Vercel](https://www.rystic.ai/docs/vercel.md) — Connect Rystic once through Vercel Connect, pull a 24-hour API key from your code, and run a metered simulator in a Vercel Sandbox. ## Simulators - [Slack](https://www.rystic.ai/docs/simulators/slack.md) — Run the Slack Web API locally, or connect an MCP agent to a seeded workspace in Harbor. - [GitHub](https://www.rystic.ai/docs/simulators/github-pulls.md) — A stateful GitHub simulator — pull requests, reviews, issues, checks, git and gh, with real permission rules. - [Kalshi](https://www.rystic.ai/docs/simulators/kalshi.md) — A local Kalshi — real matching engine, WebSocket feed, captured-day replay. - [PayPal](https://www.rystic.ai/docs/simulators/paypal.md) — Local PayPal checkout, authorization, capture and refund testing with deterministic payment history. - [Lob](https://www.rystic.ai/docs/simulators/lob.md) — A stateful Lob simulator — addresses, postcards, idempotent sends, the mail stream's unhappy paths. - [Okta](https://www.rystic.ai/docs/simulators/okta.md) — A stateful Okta Management API simulator — users and their lifecycle, groups, app assignments, passwords and software-TOTP factors. - [Linear](https://www.rystic.ai/docs/simulators/linear.md) — A stateful Linear GraphQL simulator — issues, comments, labels, projects and documents for agents that work in a workspace. - [Stripe](https://www.rystic.ai/docs/simulators/stripe.md) — A stateful Stripe simulator — charges, refunds, checkout, customers. - [Resend](https://www.rystic.ai/docs/simulators/resend.md) — A local Resend email and webhook simulator for stateful integration tests. - [Anthropic](https://www.rystic.ai/docs/simulators/anthropic.md) — A stateful Claude API simulator — Messages and token counting, models, files, message batches, skills and the Managed Agents beta, with no model called and nothing billed. - [Clerk](https://www.rystic.ai/docs/simulators/clerk.md) — A stateful Clerk Backend API simulator — users and their metadata, organizations and memberships, webhooks, and a browser sign-in companion for Next.js apps. - [Dropbox](https://www.rystic.ai/docs/simulators/dropbox.md) — A stateful Dropbox API v2 simulator — one account's files and folders, listings and search, shared links, file requests, shared folders and file members, upload sessions, batch jobs and tags. - [Gmail](https://www.rystic.ai/docs/simulators/gmail.md) — A stateful Gmail API v1 simulator — messages, threads, drafts, labels and their counts, the history feed, search and mailbox settings, for one mailbox, with nothing delivered. - [Google Drive](https://www.rystic.ai/docs/simulators/google-drive.md) — A stateful Google Drive API v3 simulator — files and folders, uploads, downloads and exports, search, permissions, comments and replies, revisions, and a change feed, each answered by the caller's role on the file. - [Notion](https://www.rystic.ai/docs/simulators/notion.md) — A stateful Notion API simulator — pages and their markdown, blocks, databases with their data sources, comments, users, file uploads and search, for agents that work in a workspace. - [S3](https://www.rystic.ai/docs/simulators/s3.md) — A stateful Amazon S3 simulator — buckets, objects, listings, multipart uploads, copies, tagging, conditional requests and checksums for storage code and the agents that drive it. - [Shopify Storefront](https://www.rystic.ai/docs/simulators/shopify-storefront.md) — A stateful Shopify Storefront API simulator — the shop, products, variants and collections, search and recommendations, pages, blogs, menus and metaobjects, and the cart with its fifteen mutations, over the one GraphQL endpoint. - [Word](https://www.rystic.ai/docs/simulators/word.md) — Run your Office.js add-in's tests against a local Word host — real office.js, tracked changes, comments and reviewed text. ## Reference - [Control plane and plans](https://www.rystic.ai/docs/control-plane.md) — Every /_rystic route and the plan that serves it, what a simulator boots and resets to, timeline events and response bindings, network fault profiles and how to discover a simulator's routes and scenarios. - [The rystic CLI](https://www.rystic.ai/docs/cli.md) — Installs, runs and health-checks every simulator — natively or as a container. - [CLI flag reference](https://www.rystic.ai/docs/cli-reference.md) — Every rystic command and flag, generated from command help. - [Docker](https://www.rystic.ai/docs/docker.md) — Container defaults, Compose command overrides, environment variables and the generated Compose file. - [Docker builder](https://www.rystic.ai/docs/docker-builder.md) — Pick your simulators, set each one's options, and copy the rystic.yaml, CLI lines and Compose file that start them. - [Fidelity](https://www.rystic.ai/docs/fidelity.md) — How we make sure each simulator matches the real API — unit tests, workflow tests, real-world usage. - [Changelog](https://www.rystic.ai/docs/changelog.md) — What changed in each simulator release, newest first. --- Source: https://www.rystic.ai/docs · Markdown: https://www.rystic.ai/docs.md