Skip to main content

REST, CLI and MCP reference, generated from the code

The Apiome team
The Apiome team

Reference now carries the three surfaces generated straight from their source, so they cannot drift from it: the REST API — a page for each of its tags — the CLI — a page for each command, plus the exit codes — and the MCP server's tools. (#5628)

  • Fails on drift — each project's tests and a CI job fail when a page no longer matches its source, and the site build fails when openapi.yaml changed without regenerating the REST pages.
  • Mock runtime and CI moved under Reference — the mock engine guides are now at Reference → Mock runtime, and Reference → CI holds the contract-gate guides with the diff-action and mock-action READMEs.
  • Quick-starts link the reference instead of restating the command and tool lists.