Framework Integrations Quickstart (Repository Source of Truth)

June 23, 2026 ยท View on GitHub

This is the canonical repository entry point for framework integrations. The repo owns the executable integration surface; deeper operational guidance can be layered externally.

1. Integration Matrix (Status + Executable Packages)

IntegrationRuntime GuardStatusRepository Package
LangChainOmegaLangChainGuardstable/integrations/langchain
LangGraphOmegaLangGraphGuardstable/integrations/langgraph
LlamaIndexOmegaLlamaIndexGuardstable/integrations/llamaindex
HaystackOmegaHaystackGuardstable/integrations/haystack
AutoGenOmegaAutoGenGuardstable/integrations/autogen
CrewAIOmegaCrewAIGuardstable/integrations/crewai
OpenClaw (Plugin SDK + WebFetch)plugin bridgebeta/integrations/openclaw

Related runbooks:

2. One-Time Install and Fast Verification

pip install "omega-walls[integrations]"
python scripts/run_framework_smokes.py --framework langchain --strict

Full matrix run (all 6 adapters, typically ~2-3 minutes):

python scripts/run_framework_smokes.py --strict

Expected summary invariants:

  • status = ok
  • framework_count = selected adapter count (1 with --framework, 6 for full matrix)
  • min_gateway_coverage >= 1.0
  • total_orphans = 0

For full contract/workflow/stress validation:

python scripts/run_framework_matrix_stand.py --layer all --profile dev --strict

3. Canonical Contract Terms

This section is the shared term glossary for all integration packages.

  • block contract: structured deny payload fields (action, reason, trace_id, decision_id, optional policy_id, incident_id, fallback_hint).
  • security_metadata: side-channel output metadata with mode, risk, action, trace_id, decision_id, and fallback markers.
  • session_id mapping: deterministic binding from framework-native run/thread/conversation IDs into Omega runtime context.
  • llm_fallback_active: explicit marker that semantic checks are degraded and fallback routing is active.

Exception path remains backward-compatible:

  • OmegaBlockedError for model/input blocking.
  • OmegaToolBlockedError for tool-call blocking.

4. Boundary Mode Presets (P3)

  • boundary_mode="recommended" (default): profile-aware mode.
    • prod / pilot / pilot_canonical -> segmented
    • quickstart / dev -> blob_fallback
  • boundary_mode="segmented": explicit production mode.
  • boundary_mode="blob_fallback": compatibility mode for legacy integrations.

LangChain/LangGraph example:

from omega.integrations import OmegaLangChainGuard

# Default is "recommended" and resolves by profile.
guard = OmegaLangChainGuard(profile="prod")

5. Minimal Adapter Wiring Pattern

from omega.adapters import OmegaBlockedError, OmegaToolBlockedError
from omega.integrations import OmegaLangChainGuard

guard = OmegaLangChainGuard(profile="quickstart")

try:
    # invoke framework runtime here
    ...
except OmegaBlockedError as exc:
    print(exc.to_contract_payload())
except OmegaToolBlockedError as exc:
    print(exc.to_contract_payload())

Use the same pattern in all official adapters and in custom wrappers.

6. SIEM-Friendly Boundary Events

security_metadata now includes siem_boundary_event with stable keys:

  • event, schema_version, timestamp, phase
  • session_id, step, trace_id, decision_id
  • boundary_mode, coverage_status, coverage_grade, missing_boundaries
  • reason_codes, risk_score, control_outcome

This object is designed to be forwarded as-is to SIEM pipelines.

7. What Is Executable in the Repo

For each integration package under /integrations/<framework>/:

  • README.md: concise install/wire/verify contract.
  • example.py: minimal wiring snippet.
  • requirements.txt: pinned dependency set.
  • test_integration.py: executable smoke launcher for CI.

Template for new frameworks:

8. Troubleshooting (Fast Path)

  1. Verify Python and package install:
    • python --version
    • pip install "omega-walls[integrations]"
  2. Run framework-specific smoke from the integration package README.
  3. Run matrix stand contract layer:
    • python scripts/run_framework_matrix_stand.py --layer contract --profile dev --strict
  4. Inspect generated artifacts under artifacts/ for exact failure causes.