# Documentation for Agents and Scripts

Channel: development; package: 2.0.0rc1; source: 2c32b7cf79b796fae825bfa08fc73d9914e61723

Page: https://remilab.ai/rfx/api/machine-readable/
Source: https://github.com/bk-squared/rfx/blob/2c32b7cf79b796fae825bfa08fc73d9914e61723/docs/public/api/machine-readable.mdx

Start with [llms.txt](https://remilab.ai/rfx/llms.txt). It links the same manuals and examples
served on this site, as plain Markdown without navigation markup. Each Markdown
page identifies its documentation channel, package version, source commit and
human-readable URL.

For a command-line reader:

```bash
curl --fail --location https://remilab.ai/rfx/llms.txt
```

Check the HTTP status before treating a response as documentation. The public
edge can return an HTTP 403 response containing Cloudflare error 1010 to some automated client user agents;
an HTML error response is not an empty API reference. The curl command above
and Python `requests` were checked against these public endpoints.

| Resource | Contents |
|---|---|
| [Documentation index](https://remilab.ai/rfx/llms.txt) | Task-oriented links to the public pages and API |
| [Combined manual](https://remilab.ai/rfx/llms-full.txt) | Public page text and code in one document |
| [Typed API inventory](https://remilab.ai/rfx/api/inventory.json) | Importable exports and public `Simulation` methods, generated from Python |
| [Support contract](https://remilab.ai/rfx/api/support/support_matrix.json) | The source repository's unchanged configuration support data |
| [S-parameter contract](https://remilab.ai/rfx/api/support/sparameter_support_matrix.json) | Port families, calculators, result conventions and restrictions |
| [Build manifest](https://remilab.ai/rfx/docs-manifest.json) | Source identity, page URLs, source files and artifact hashes |
| [Deep reference](https://remilab.ai/rfx/api/generated/rfx.html) | Rendered signatures and full docstrings |

## Read the constraints with the signature

A signature tells you what can be called. The support contracts and
[support boundaries](https://remilab.ai/rfx/support/) tell you which combinations
have documented evidence. A successful preflight or a completed run does not
establish accuracy. Historical gallery artifacts retain their original provenance;
the documentation build commit is not a new simulation run.

The inventory preserves annotations and docstrings as written. It does not invent
missing units, shape constraints, support levels or validation claims. Use the
parameter descriptions and result conventions alongside the signature, then
follow the commit-pinned source link when more detail is needed.

A useful request to a coding agent is:

> Read this version's llms.txt, API inventory and support contracts. Select the
> matching example and measurement API, state its units and configuration limits,
> and cite the source commit. Do not turn a field probe into a port S-parameter
> calculator or claim that an optimization movie verifies a gradient.

## Match the installed version

The documentation channel and source SHA appear on each page. Development docs
may describe changes after the installed release. Use the corresponding release
snapshot when available and compare its package version with `rfx.__version__`.
The JSON `schema_version` identifies the file format; it is separate from the
simulator's `package_version`.