---
title: Reference
---

Reference pages say what exists and what each option means. The reasons behind a design are in
[Concepts](/concepts/memory) and [Architecture](/architecture/system-overview).
Procedures are in the [guides](/guides/agent-integration) and
[operations](/operations/deployment) sections.

## Generated from the code

These pages, or the tables in them, are rendered from the source that defines them. Each
generator has a `--check` mode that `make lint` runs, so a page that drifts from the code fails
CI. Edit the source and regenerate; never edit a generated table by hand.

| Page                                | What it lists                                                                                                 | Source                                                                               | Generator                                      |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ---------------------------------------------- |
| [Configuration](/reference/configuration) | Every `LOOM_*` setting, its default and meaning, by area.                                                     | the comments above fields in `server/settings/`                                      | `python scripts/codegen/settings_reference.py` |
| [Operations](/reference/operations)       | Every operation, grouped, with role, kind, MCP `all` listing and audit flag; plus how the registry works.     | `server.operations.registry.ALL_OPERATIONS`                                          | `python scripts/codegen/docs_reference.py`     |
| [Workers](/reference/workers)             | Every background worker, its switch, default and cadence; plus how the supervisor runs them.                  | `server/workers/registry.py` (`_WORKERS`)                                            | `python scripts/codegen/docs_reference.py`     |
| [CLI](/reference/cli)                     | Every `loom` command and subcommand with its flags; plus where the CLI runs and the common commands.          | the `loom` parser tree (`tests/unit/snapshots/cli_tree.json`)                        | `python scripts/codegen/docs_reference.py`     |
| [Errors](/reference/errors)               | Every error code the server answers with; plus the envelope, retry rules and fixes for the common codes.      | `server/core/errors.py` and every `"code"` literal under `server/`                   | `python scripts/codegen/docs_reference.py`     |
| [Status](/reference/status)               | How many of each op group's ops are stable, each experimental op, and every boolean setting that loads false. | op `maturity` in the registry and the boolean fields of `server/settings/catalog.py` | `python scripts/codegen/docs_reference.py`     |
| [Schema](/reference/schema)               | Every table and materialized view with engine, keys, TTL and indexes; plus the column conventions.            | `schemas/schema.sql`                                                                 | `python scripts/codegen/docs_reference.py`     |

On the `docs_reference.py` pages only the regions between the
`<!-- BEGIN GENERATED: … -->` and `<!-- END GENERATED: … -->` markers are generated; the prose
around them is hand-written. The op tables inside the SDK packages (`sdk/python/loom/ops.py`,
`sdk/typescript/src/generated/ops.ts`) are generated too, by
`scripts/codegen/sdk_py_gen.py` and `sdk_ts_gen.py`; see
[Code generation](/development/code-generation).

## Written by hand

| Page                                          | What it covers                                                                                                                                                     |
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| [HTTP API](/reference/http-api)                     | Every route (ops, discovery, health, streams, sign-in, OAuth, dashboard, operator), the gate order, headers, unknown fields, idempotency, pagination, rate limits. |
| [MCP](/reference/mcp)                               | The `/mcp` endpoint, authentication and OAuth, sessions and identity, the tool list and toolsets, results, errors, the action-schema export.                       |
| [Python SDK](/reference/python-sdk)                 | Install, construction, calling ops, typed shapes, sessions and tools, framework adapters, errors, retries.                                                         |
| [TypeScript SDK](/reference/typescript-sdk)         | Install, clients and options, typed ops, sessions and tools, pagination, the Strands adapter, errors, retries.                                                     |
| [Environment variables](/reference/environment)     | Variables read outside the settings model: provider keys, the image, compose files, the CLI, the SDKs and the operator scripts.                                    |
| [SQL surface](/reference/sql-surface)               | The read-only `sql_v1_*` views over a tenant's data: columns, compatibility rule, what they withhold, freshness, `loom sql-access`.                                |
| [Extractor contract](/reference/extractor-contract) | Version 1 of the HTTP contract an extractor service serves: capabilities, extraction, error codes, the artifact's fields and rules.                                |

The hand-written pages name only things that exist in the tree and link to the source they
describe.

## Which page answers…

- "What is this op called, and who may call it?" → [Operations](/reference/operations).
- "What does this setting do?" → [Configuration](/reference/configuration).
- "What does this error code mean, and should I retry?" → [Errors](/reference/errors).
- "Is this op stable or experimental, and is this setting on by default?" → [Status](/reference/status).
- "Which header, which route, how do I page?" → [HTTP API](/reference/http-api).
- "Why does my MCP client not list a tool?" → [MCP](/reference/mcp#toolsets).
- "Is this worker running, and how do I turn it on?" → [Workers](/reference/workers).
- "Will my client break on the next deploy?" → [unknown and removed fields](/reference/http-api#unknown-and-removed-fields) and [discovering what a deployment serves](/reference/http-api#discovering-what-a-deployment-serves).
- "What is in this table?" → [Schema](/reference/schema).
- "What does `loom <command>` take?" → [CLI](/reference/cli).
