Reference
Reference holds the material generated from the source: the REST API (from the OpenAPI document),
the MCP tools, the mock runtime and the CI actions. The apiome command line has its own
CLI guide — the quick-start and a page per command.
The three surface references are generated from the code, so they cannot drift from it:
| Reference | Generated from | Regenerate with |
|---|---|---|
| REST API — a page per tag | apiome-rest/openapi.yaml | cd apiome-rest && uv run python scripts/generate_rest_reference_docs.py |
| CLI — a page per command, plus exit codes (in the CLI guide) | the apiome command tree | cd apiome-cli && uv run python scripts/generate_cli_reference_docs.py |
| MCP — tools, resources and prompts | the MCP server's registry | cd apiome-mcp && uv run python scripts/generate_mcp_reference_docs.py |
Each project's tests fail when its pages are stale, CI runs every generator with --check, and the
site build fails when openapi.yaml changed without regenerating the REST pages.
The Mock runtime guides cover the bundle format, fixtures, callbacks, correlation, capture and attestation; CI holds the GitHub Actions and the GitLab and Bitbucket recipes. To get going quickly, start with the MCP quick-start.
API reference
Where the REST service's interactive reference lives and how to authenticate.
REST API
81 items
MCP quick-start
Connect Claude Desktop or an IDE to published specs over MCP.
MCP
3 items
Mock runtime
10 items
CI
4 items
Content and voice
How empty, loading, error and gated states read, and the per-route checklist.