fauxcall 0.1.0__tar.gz

fauxcall-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

fauxcall-0.1.0/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: fauxcall
+Version: 0.1.0
+Summary: Record real APIs and MCP servers, then serve high-fidelity, consistent, time-aware fakes for repeatable agent testing.
+Keywords: mock,fake,api,mcp,openapi,agents,testing,evaluation,claude-code
+Author: Brad Nemetski
+Author-email: Brad Nemetski <brad.nemetski@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Testing :: Mocking
+Classifier: Typing :: Typed
+Requires-Dist: beautifulsoup4>=4.12
+Requires-Dist: faker>=30.0
+Requires-Dist: fastapi>=0.120
+Requires-Dist: httpx2[ws]>=2.10
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: jsonschema>=4.23
+Requires-Dist: pydantic>=2.12
+Requires-Dist: pydantic-settings>=2.10
+Requires-Dist: python-multipart>=0.0.20
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: structlog>=25.1
+Requires-Dist: typer>=0.16
+Requires-Dist: typesafe-sdk>=0.7
+Requires-Dist: tzdata>=2025.2
+Requires-Dist: uvicorn[standard]>=0.35
+Requires-Dist: pytest>=9.0 ; extra == 'testing'
+Requires-Dist: pytest-asyncio>=1.2 ; extra == 'testing'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/bradnemetski/fauxcall
+Project-URL: Repository, https://github.com/bradnemetski/fauxcall
+Project-URL: Issues, https://github.com/bradnemetski/fauxcall/issues
+Project-URL: Changelog, https://github.com/bradnemetski/fauxcall/blob/main/CHANGELOG.md
+Provides-Extra: testing
+Description-Content-Type: text/markdown
+
+# FauxCall
+
+**Build a faithful fake of any API or MCP server, so you can test your agents without touching the
+real thing.**
+
+Give FauxCall an API's Swagger/OpenAPI page, its documentation, or the address of an MCP server. It
+calls the real service, one endpoint at a time, and builds a local copy that answers the same way:
+the same URLs, parameters, responses and errors. Then it runs the same tests against both and
+keeps fixing the fake until they agree at least 98% of the time.
+
+```text
+/fauxcall https://petstore3.swagger.io
+```
+
+## Why
+
+Testing agents against real services is painful. The data changes between runs, calls cost money
+and hit rate limits, and you really don't want a test run to place an actual order. Hand-written
+mocks avoid that but bring their own problems: they slowly drift away from the real API, their data
+doesn't hang together, and they ignore time completely.
+
+A FauxCall fake is built from real responses, so it behaves like the original:
+
+- **It looks the same.** Every URL, parameter, status code, header and error message matches, down
+  to how numbers are written (`1.50` stays `1.50`). MCP fakes have the same tools, resources and
+  prompts.
+- **Its data adds up.** If a stock references an exchange, that exchange exists. If you upload a
+  file, it shows up in the status endpoint and goes through the same steps, at the same pace, as on
+  the real API.
+- **It knows what time it is.** Asking for the current time gets you the actual time. A stock's
+  timestamp moves during trading hours and stops at the last trade overnight, while the price stays
+  where it closed. Dates come back in exactly the real format.
+- **It behaves like the real thing under load.** Real response times, the real rate limits (with
+  proper `429` errors), pagination, background jobs, file uploads and downloads, live streams
+  (Server-Sent Events and WebSockets), and MCP over HTTP, including sign-in with OAuth.
+- **It's made for testing.** You can freeze or move the clock, see every call your agent made,
+  inject failures, give parallel test runs their own separate state, and reset everything between
+  runs.
+
+## Quick start (Claude Code)
+
+You need [Claude Code](https://claude.com/claude-code) and [uv](https://docs.astral.sh/uv/). uv
+takes care of installing Python.
+
+1. **Install the plugin:**
+
+   ```bash
+   claude plugin marketplace add bradnemetski/fauxcall
+   claude plugin install fauxcall@fauxcall
+   ```
+
+   (Inside Claude Code, `/plugin marketplace add bradnemetski/fauxcall` and
+   `/plugin install fauxcall@fauxcall` do the same.)
+
+2. **Build a fake.** In Claude Code, point the skill at a spec, a docs page or an MCP server:
+
+   ```text
+   /fauxcall https://petstore3.swagger.io
+   /fauxcall https://api.frankfurter.dev/v1/openapi.json
+   /fauxcall https://mcp.deepwiki.com/mcp
+   ```
+
+   Before it starts, Claude asks you everything it needs in one go: any credentials, whether you
+   have a Jev key, and permission for calls that would change data on the real service, along with
+   how many such calls it may make. After that it works on its own. If it gets interrupted, run the
+   same command again and it picks up where it stopped.
+
+3. **Run the fake and point your agent at it:**
+
+   ```bash
+   uvx fauxcall up       # starts every fake in ./fauxcall and prints their addresses
+   ```
+
+   Use the printed address instead of the real API's. For an MCP server, FauxCall also prints the
+   snippet to paste into your agent's configuration.
+
+## Using it with other agents
+
+FauxCall isn't tied to Claude Code. Its skills are plain [Agent Skills](https://agentskills.io)
+(`SKILL.md` files), and all the real work happens in the `fauxcall` command, so any agent that
+reads skills and can run shell commands can use it: Codex, Gemini CLI, Cursor, GitHub Copilot and
+others.
+
+1. **Install the `fauxcall` command:**
+
+   ```bash
+   uv tool install fauxcall                                       # once it's on PyPI
+   uv tool install git+https://github.com/bradnemetski/fauxcall   # or straight from GitHub
+   ```
+
+2. **Copy the skills to where your agent looks for them.** Most agents read the shared
+   `~/.agents/skills/` folder (or `.agents/skills/` inside a project); some also have their own,
+   such as `~/.cursor/skills/` or `.github/skills/`. Check your agent's documentation.
+
+   ```bash
+   git clone https://github.com/bradnemetski/fauxcall
+   mkdir -p ~/.agents/skills
+   cp -R fauxcall/plugins/fauxcall/skills/* ~/.agents/skills/
+   ```
+
+   That installs five skills: `fauxcall`, `refresh`, `verify`, `extend` and `serve`. If those last
+   four names clash with skills you already have, copy just `fauxcall`. It covers a whole build on
+   its own.
+
+3. **Ask your agent to use it**, for example "use the fauxcall skill to fake
+   https://petstore3.swagger.io".
+
+A few things are smoother in Claude Code: it asks the up-front questions as a form, and runs the
+final independent review as a separate subagent. Other agents do the same steps in the
+conversation.
+
+## What you get
+
+Each fake is a small, ordinary FastAPI project in `./fauxcall/<name>/`:
+
+```text
+your-project/
+├── fauxcall/
+│   ├── petstore/
+│   │   ├── data/model.json          # everything the fake knows, in one readable file
+│   │   ├── data/recordings/         # the real requests and responses it was built from
+│   │   ├── data/world/              # the data it serves
+│   │   ├── src/fauxcall_petstore/   # its routes, plus any custom code
+│   │   ├── tests/                   # its tests
+│   │   └── Dockerfile
+│   ├── compose.yaml                 # runs all your fakes in containers
+│   └── pyproject.toml               # one uv workspace for all of them
+└── .github/workflows/fauxcall.yml   # CI that keeps the fakes tested
+```
+
+Run a fake's tests offline, or against the real service to see whether the real API has changed:
+
+```bash
+cd fauxcall/petstore
+uv run pytest                                 # offline tests
+uv run pytest tests/e2e --target=parity       # same tests against both; fails below 98%
+```
+
+The [`examples/`](examples/) folder has fakes FauxCall built by itself, from a single command each,
+while we were testing it: Frankfurter, timeapi.io, Swagger Petstore, FakeRESTApi and this
+repository's own reference API.
+
+## Using fakes in tests
+
+Every fake has a small control API under `/__fauxcall`:
+
+| Call | What it does |
+|---|---|
+| `POST /__fauxcall/reset` | Put the data back the way it was recorded (for everyone, or for one test run) |
+| `POST /__fauxcall/clock` | Freeze time, jump to a date, speed it up, or go back to real time. Moving the clock forward also lifts rate limits |
+| `GET /__fauxcall/journal` | List every call your agent made, with requests and responses |
+| `PUT /__fauxcall/faults` | Make calls fail: errors, timeouts, delays, dropped connections or `429`s |
+| `PUT /__fauxcall/auth/users` | Choose which users are allowed, refused or expired |
+
+To run tests in parallel, give each run its own name in an `X-Fauxcall-Session` header. It then gets
+its own data and its own clock. Set `FAUXCALL_FAST=1` to skip the realistic delays and rate limits.
+
+## Skills
+
+| Skill | What it's for |
+|---|---|
+| `/fauxcall <url>` | Build a fake, or carry on with an interrupted build |
+| `/fauxcall:refresh <name>` | Re-record a fake after the real API has changed |
+| `/fauxcall:verify <name>` | Check a fake against the real service and fix what's off |
+| `/fauxcall:extend <name>` | Add endpoints, test scenarios or behavior to a fake |
+| `/fauxcall:serve` | Start fakes and hook them up to your agent |
+
+## Privacy and safety
+
+- **Your credentials stay private.** They live only in each fake's `.env` file, which you fill in
+  and which git ignores. They're scrubbed from recordings, logs and the call journal, and never
+  copied into Docker images.
+- **Personal data is replaced with realistic stand-ins** as it's recorded, consistently, so a
+  customer's name is replaced the same way in every response.
+- **Nothing that changes data happens without your OK.** Before recording, you see the calls that
+  would create, change or delete things, and approve them once. You also set how many such calls
+  each endpoint may make (100 unless you choose otherwise; set `FAUXCALL_APPROVAL_BUDGET` to change
+  the default).
+- **It's polite to the real service.** Recording is slowed down to stay within rate limits, and
+  capped.
+
+## Jev (optional)
+
+If you have a [TypeSafe](https://typesafe.ai) Jev key, a fake can use it to make judgment calls its
+recordings don't cover, for example picking which recorded answer best fits a question it hasn't
+seen before. Its answers are saved with the fake, so they replay later without the key. Without a
+key, the fake uses simple, predictable rules instead.
+
+## The `fauxcall` command
+
+The skills drive the `fauxcall` command-line tool, and you can use it directly too:
+
+```bash
+uvx fauxcall status                 # how far each fake's build has got
+uvx fauxcall serve petstore         # run one fake in the foreground
+uvx fauxcall verify petstore --target parity
+uvx fauxcall --help                 # everything else
+```
+
+## Learn more
+
+- [Examples](examples/): fakes FauxCall built by itself, ready to run
+- [How it was tested](docs/validation.md): the method, the services we tried and the results
+- [How it works](docs/architecture.md): the pipeline, the model and the runtime
+- [Configuration](docs/configuration.md): every setting
+- [Design decisions](docs/decisions.md): what we decided and why
+- [Contributing](CONTRIBUTING.md) and [security](SECURITY.md)
+
+## License
+
+[Apache-2.0](LICENSE)

fauxcall-0.1.0/README.md

@@ -0,0 +1,211 @@
+# FauxCall
+
+**Build a faithful fake of any API or MCP server, so you can test your agents without touching the
+real thing.**
+
+Give FauxCall an API's Swagger/OpenAPI page, its documentation, or the address of an MCP server. It
+calls the real service, one endpoint at a time, and builds a local copy that answers the same way:
+the same URLs, parameters, responses and errors. Then it runs the same tests against both and
+keeps fixing the fake until they agree at least 98% of the time.
+
+```text
+/fauxcall https://petstore3.swagger.io
+```
+
+## Why
+
+Testing agents against real services is painful. The data changes between runs, calls cost money
+and hit rate limits, and you really don't want a test run to place an actual order. Hand-written
+mocks avoid that but bring their own problems: they slowly drift away from the real API, their data
+doesn't hang together, and they ignore time completely.
+
+A FauxCall fake is built from real responses, so it behaves like the original:
+
+- **It looks the same.** Every URL, parameter, status code, header and error message matches, down
+  to how numbers are written (`1.50` stays `1.50`). MCP fakes have the same tools, resources and
+  prompts.
+- **Its data adds up.** If a stock references an exchange, that exchange exists. If you upload a
+  file, it shows up in the status endpoint and goes through the same steps, at the same pace, as on
+  the real API.
+- **It knows what time it is.** Asking for the current time gets you the actual time. A stock's
+  timestamp moves during trading hours and stops at the last trade overnight, while the price stays
+  where it closed. Dates come back in exactly the real format.
+- **It behaves like the real thing under load.** Real response times, the real rate limits (with
+  proper `429` errors), pagination, background jobs, file uploads and downloads, live streams
+  (Server-Sent Events and WebSockets), and MCP over HTTP, including sign-in with OAuth.
+- **It's made for testing.** You can freeze or move the clock, see every call your agent made,
+  inject failures, give parallel test runs their own separate state, and reset everything between
+  runs.
+
+## Quick start (Claude Code)
+
+You need [Claude Code](https://claude.com/claude-code) and [uv](https://docs.astral.sh/uv/). uv
+takes care of installing Python.
+
+1. **Install the plugin:**
+
+   ```bash
+   claude plugin marketplace add bradnemetski/fauxcall
+   claude plugin install fauxcall@fauxcall
+   ```
+
+   (Inside Claude Code, `/plugin marketplace add bradnemetski/fauxcall` and
+   `/plugin install fauxcall@fauxcall` do the same.)
+
+2. **Build a fake.** In Claude Code, point the skill at a spec, a docs page or an MCP server:
+
+   ```text
+   /fauxcall https://petstore3.swagger.io
+   /fauxcall https://api.frankfurter.dev/v1/openapi.json
+   /fauxcall https://mcp.deepwiki.com/mcp
+   ```
+
+   Before it starts, Claude asks you everything it needs in one go: any credentials, whether you
+   have a Jev key, and permission for calls that would change data on the real service, along with
+   how many such calls it may make. After that it works on its own. If it gets interrupted, run the
+   same command again and it picks up where it stopped.
+
+3. **Run the fake and point your agent at it:**
+
+   ```bash
+   uvx fauxcall up       # starts every fake in ./fauxcall and prints their addresses
+   ```
+
+   Use the printed address instead of the real API's. For an MCP server, FauxCall also prints the
+   snippet to paste into your agent's configuration.
+
+## Using it with other agents
+
+FauxCall isn't tied to Claude Code. Its skills are plain [Agent Skills](https://agentskills.io)
+(`SKILL.md` files), and all the real work happens in the `fauxcall` command, so any agent that
+reads skills and can run shell commands can use it: Codex, Gemini CLI, Cursor, GitHub Copilot and
+others.
+
+1. **Install the `fauxcall` command:**
+
+   ```bash
+   uv tool install fauxcall                                       # once it's on PyPI
+   uv tool install git+https://github.com/bradnemetski/fauxcall   # or straight from GitHub
+   ```
+
+2. **Copy the skills to where your agent looks for them.** Most agents read the shared
+   `~/.agents/skills/` folder (or `.agents/skills/` inside a project); some also have their own,
+   such as `~/.cursor/skills/` or `.github/skills/`. Check your agent's documentation.
+
+   ```bash
+   git clone https://github.com/bradnemetski/fauxcall
+   mkdir -p ~/.agents/skills
+   cp -R fauxcall/plugins/fauxcall/skills/* ~/.agents/skills/
+   ```
+
+   That installs five skills: `fauxcall`, `refresh`, `verify`, `extend` and `serve`. If those last
+   four names clash with skills you already have, copy just `fauxcall`. It covers a whole build on
+   its own.
+
+3. **Ask your agent to use it**, for example "use the fauxcall skill to fake
+   https://petstore3.swagger.io".
+
+A few things are smoother in Claude Code: it asks the up-front questions as a form, and runs the
+final independent review as a separate subagent. Other agents do the same steps in the
+conversation.
+
+## What you get
+
+Each fake is a small, ordinary FastAPI project in `./fauxcall/<name>/`:
+
+```text
+your-project/
+├── fauxcall/
+│   ├── petstore/
+│   │   ├── data/model.json          # everything the fake knows, in one readable file
+│   │   ├── data/recordings/         # the real requests and responses it was built from
+│   │   ├── data/world/              # the data it serves
+│   │   ├── src/fauxcall_petstore/   # its routes, plus any custom code
+│   │   ├── tests/                   # its tests
+│   │   └── Dockerfile
+│   ├── compose.yaml                 # runs all your fakes in containers
+│   └── pyproject.toml               # one uv workspace for all of them
+└── .github/workflows/fauxcall.yml   # CI that keeps the fakes tested
+```
+
+Run a fake's tests offline, or against the real service to see whether the real API has changed:
+
+```bash
+cd fauxcall/petstore
+uv run pytest                                 # offline tests
+uv run pytest tests/e2e --target=parity       # same tests against both; fails below 98%
+```
+
+The [`examples/`](examples/) folder has fakes FauxCall built by itself, from a single command each,
+while we were testing it: Frankfurter, timeapi.io, Swagger Petstore, FakeRESTApi and this
+repository's own reference API.
+
+## Using fakes in tests
+
+Every fake has a small control API under `/__fauxcall`:
+
+| Call | What it does |
+|---|---|
+| `POST /__fauxcall/reset` | Put the data back the way it was recorded (for everyone, or for one test run) |
+| `POST /__fauxcall/clock` | Freeze time, jump to a date, speed it up, or go back to real time. Moving the clock forward also lifts rate limits |
+| `GET /__fauxcall/journal` | List every call your agent made, with requests and responses |
+| `PUT /__fauxcall/faults` | Make calls fail: errors, timeouts, delays, dropped connections or `429`s |
+| `PUT /__fauxcall/auth/users` | Choose which users are allowed, refused or expired |
+
+To run tests in parallel, give each run its own name in an `X-Fauxcall-Session` header. It then gets
+its own data and its own clock. Set `FAUXCALL_FAST=1` to skip the realistic delays and rate limits.
+
+## Skills
+
+| Skill | What it's for |
+|---|---|
+| `/fauxcall <url>` | Build a fake, or carry on with an interrupted build |
+| `/fauxcall:refresh <name>` | Re-record a fake after the real API has changed |
+| `/fauxcall:verify <name>` | Check a fake against the real service and fix what's off |
+| `/fauxcall:extend <name>` | Add endpoints, test scenarios or behavior to a fake |
+| `/fauxcall:serve` | Start fakes and hook them up to your agent |
+
+## Privacy and safety
+
+- **Your credentials stay private.** They live only in each fake's `.env` file, which you fill in
+  and which git ignores. They're scrubbed from recordings, logs and the call journal, and never
+  copied into Docker images.
+- **Personal data is replaced with realistic stand-ins** as it's recorded, consistently, so a
+  customer's name is replaced the same way in every response.
+- **Nothing that changes data happens without your OK.** Before recording, you see the calls that
+  would create, change or delete things, and approve them once. You also set how many such calls
+  each endpoint may make (100 unless you choose otherwise; set `FAUXCALL_APPROVAL_BUDGET` to change
+  the default).
+- **It's polite to the real service.** Recording is slowed down to stay within rate limits, and
+  capped.
+
+## Jev (optional)
+
+If you have a [TypeSafe](https://typesafe.ai) Jev key, a fake can use it to make judgment calls its
+recordings don't cover, for example picking which recorded answer best fits a question it hasn't
+seen before. Its answers are saved with the fake, so they replay later without the key. Without a
+key, the fake uses simple, predictable rules instead.
+
+## The `fauxcall` command
+
+The skills drive the `fauxcall` command-line tool, and you can use it directly too:
+
+```bash
+uvx fauxcall status                 # how far each fake's build has got
+uvx fauxcall serve petstore         # run one fake in the foreground
+uvx fauxcall verify petstore --target parity
+uvx fauxcall --help                 # everything else
+```
+
+## Learn more
+
+- [Examples](examples/): fakes FauxCall built by itself, ready to run
+- [How it was tested](docs/validation.md): the method, the services we tried and the results
+- [How it works](docs/architecture.md): the pipeline, the model and the runtime
+- [Configuration](docs/configuration.md): every setting
+- [Design decisions](docs/decisions.md): what we decided and why
+- [Contributing](CONTRIBUTING.md) and [security](SECURITY.md)
+
+## License
+
+[Apache-2.0](LICENSE)