Reference¶
Auto-generated reference material. Pages here are regenerated on every
docs build from the actual source code — if a tool, model, or endpoint
exists in the codebase, it appears here. If something is missing, the
tool-catalog-check.yml
CI gate fails.
What's here¶
- Tools — every
@mcp.toolregistered with FastMCP, grouped by Saldeo resource (documents, invoices, contractors, …). - Models — input and response Pydantic models with field constraints and validators.
- Configuration — environment variables and CLI flags.
- Error codes — Saldeo-issued and synthetic codes, with recovery hints.
- API versions — which Saldeo REST API version each tool currently targets.
- Changelog — release history (Keep a Changelog format).
How auto-generation works
Three things ensure these pages stay current:
- Build-time generation —
mkdocs-gen-filesruns thescripts/gen_*.pygenerators every time the site is built. - Drift gate in CI —
tool-catalog-check.ymlregenerates the catalog and fails the PR if the diff is non-empty without a commit. - Docstring contract —
scripts/check_docstring_contract.py(also a pre-commit hook) asserts every tool's docstring contains a one-line summary, aUse this when …discriminator, anArgs:section, and aReturns:section.
See Architecture: documentation pipeline for the full flow.