Agent quick start

You are a coding agent trying Rystic for a human. Installation is the quickstart for you both; this page holds only what you need beyond it. What you can do maps each task to the page that explains it.

What to do

1. Follow Installation end to end. Without a browser says what to hand the human at the sign-in, which you cannot approve.
2. Ask which plan they are on, Free, Pro or Enterprise. An Enterprise customer may hand you a license file or install link instead (Plans and API keys).
3. Discover before guessing (Discover what a simulator can do): rystic docs <product>, GET /_rystic/routes, the scenario list.
4. Try each simulator the human cares about. Run the Quickstart on its page, load a scenario, read GET /_rystic/egress and run one worked example from that page.
5. Optional, only if the human asked: point this repository’s client at the simulator and run its existing tests against it (below).
6. Report back (below).

Each simulator has a page under Simulators.

What to report

1. The login output and rystic doctor <product> for each simulator.
2. rystic ps.
3. One request and response per simulator.
4. Anything that failed or returned 403 or 404, with the command and the body.
5. Anything the human’s code relies on that the simulator’s page lists under Limitations.

Two things agents get wrong

1. Webhooks are not sent by default. Where Which simulators send what says the egress log holds them, assert on the log instead of a receiver.
2. A scenario file has a wrapper. Its records sit under seed: Two shapes.

Swap the vendor for the simulator in a test suite

1. Where the client is constructed, add a base-URL override from an environment variable (STRIPE_API_BASE, GITHUB_API_URL) that defaults to the vendor.
2. Start the simulator detached. In test setup, POST /_rystic/scenario with the scenario the test needs, so tests are order-independent.
3. Assert on GET /_rystic/egress (above).
4. Run the suite. For each failure, check the simulator page’s limitations before touching the test.
5. rystic stop <name> in teardown.

To run the same suite in GitHub Actions, see Integration tests in CI. To inject latency or 429s, see Network profiles and fault injection.

Tell Rystic

When a simulator differs from the real API, or something fails, is missing or confuses you, rystic feedback files a report. Send one only when the human asks, and show them it first.

rystic feedback --type bug --command "stripe POST /v1/charges" \
  --task "charge a declined test card" --expected "402 card_declined" --actual "200 succeeded" \
  "the simulator accepted tok_chargeDeclined"
# filed <report id> — thank you; Rystic reads every report

Past 100 reports an hour per key it returns rate_limited; do not retry. rystic feedback lists its flags and what the CLI adds.

Machine-readable surfaces

Claude Code takes the docs MCP in one line:

claude mcp add --transport http rystic https://www.rystic.ai/mcp