Skip to content

For LLM assistants

Use the current documentation when generating LazyBridge code. This refresh targets 1.8.2, including the Codex transport fixes and Claude Code / Codex engines, native aliases and opposite-engine review.

Available surfaces

Surface Where Use
Bundled Claude skill lazybridge/skill/ Offline construction guidance; verify newer engine behavior in the guides
llms.txt Index Fetch relevant pages by topic
llms-full.txt Corpus Generated selected documentation; check size against the consuming model's budget
Codegen contract Current contract Engine/config placement, return types, persistence and removed APIs

Skills are guidance rather than runtime enforcement. The bundled skill and llms.json remain companion resources; the current codegen contract and source signatures cover this refresh. No code-generation behavior or model context fit is guaranteed by loading a skill.

Bundled skill and machine-readable contract

The skill ships with the Python package at lazybridge/skill/. Follow Claude skill install for the supported local installation and packaged archive paths. It describes the mental model, canonical Agent construction, sugar equivalents and common invalid APIs.

The companion llms.json provides import maps, canonical patterns and anti-patterns. Use the canonical vs sugar reference for convenience factories. Human review, source signatures and execution tests remain necessary; the bundled skill is guidance, not a runtime validator.

Why several surfaces?

Compatible assistant environments can load reusable skill guidance. Link-aware consumers can retrieve relevant pages from llms.txt. Consumers that require inline documentation can use llms-full.txt after checking their remaining context budget. The codegen contract is a focused current API checklist.

These formats solve different delivery problems. Neither a provider name nor a context-window label guarantees discovery, adherence or fit. Generated files update with each build; the hand-authored skill and JSON contract require maintenance against source as APIs change.

Start with the engine workflow

Corpus generation

MkDocs generates llms.txt/llms-full.txt from configured sections on every build. The index covers those sections, rather than every file in docs. Audit notes and marketing drafts are excluded from the assistant corpus. Fetch relevant pages when the full corpus does not fit; no fixed line count or token-budget guarantee is maintained.

See llms.txt explained, Claude skill install, error recovery and reference.

A practical generation workflow

  1. Read the codegen contract and the guide for the selected engine.
  2. Resolve only the additional tools/state/Plan pages the task requires.
  3. Generate canonical construction with explicit names and bounded behavior.
  4. Execute examples with mock model transports before trying authenticated work.
  5. Use schema checks, deterministic tests and explicit acceptance for release.

For credentials, aliases and permissions, inspect the local runtime and source version rather than filling gaps from a remembered training-data API.