Skip to main content

Integrations

Documentation Map​

Integrations

Overview​

This repository integrates with runtime components and host contracts through scripts, config files, and HTTP-based verification. It does not expose its own API, webhook, or MCP surface.

Internal Helpifyr / OpenClaw Connections​

OpenClaw host configuration​

  • Direction: outgoing
  • Type: file contract
  • Surface: target openclaw.json, .env, extension path
  • Auth: host filesystem permissions
  • Stability: internal
  • Versioning: OpenClaw-version-sensitive file contract; no standalone version of this repository-owned surface
  • Owner: operator on the target OpenClaw host
  • Mode: control
  • Retry mode: manual rerun or scripted reapply
  • Failure mode: incorrect config or slot state, requiring rollback or reapply
  • Purpose: install, configure, reapply, rollback, and verify the semantic memory add-on

openclaw-mem0 community fork​

  • Direction: outgoing
  • Type: file contract
  • Surface: plugin source checkout and patched plugin files
  • Auth: filesystem permissions and git access
  • Stability: unstable
  • Versioning: pinned community-fork git ref plus target OpenClaw compatibility expectations
  • Owner: repository operator plus upstream community fork maintainers
  • Mode: control
  • Retry mode: rerun patch or reapply against the pinned plugin ref
  • Failure mode: patch drift or broken runtime behavior after upstream changes
  • Purpose: provide Mem0 runtime behavior compatible with LocalAI and the target OpenClaw host

External Runtime Connections​

LocalAI embeddings runtime​

  • Direction: outgoing
  • Type: REST API
  • Surface: POST /v1/embeddings, GET /v1/models, GET /readyz
  • Auth: none by default, deployment-specific auth possible
  • Stability: stable
  • Versioning: OpenAI-compatible endpoint surface; model alias and image tag remain operator-selected
  • Owner: target runtime operator
  • Mode: read/write
  • Retry mode: retry smoke checks or rerun the operator workflow after runtime recovery
  • Failure mode: embeddings unavailable or wrong model alias configured, degrading semantic memory
  • Purpose: generate embeddings and verify model/runtime readiness
  • Canonical env/url contract:
    • MEM0_HF_BASE_URL (OpenClaw .env, gateway runtime context)
    • LOCALAI_BASE_URL (installer/operator input)
    • LOCALAI_EMBEDDING_MODEL_FILE + LOCALAI_EMBEDDING_MODEL_URL (deterministic artifact contract)
    • compose-mode default in this repository points to host-reachable URL (http://<internal-runtime-redacted>:8088/v1) to avoid loopback drift

Qdrant vector store​

  • Direction: outgoing
  • Type: REST API
  • Surface: collection inspection, collection bootstrap, search operations
  • Auth: none by default, deployment-specific auth possible
  • Stability: stable
  • Versioning: HTTP API is versioned by Qdrant release; collection schema expectations are defined by this repository
  • Owner: target runtime operator
  • Mode: read/write
  • Retry mode: rerun collection bootstrap or verification after endpoint recovery
  • Failure mode: collection unavailable, wrong dimensions/indexes, or memory search failures
  • Purpose: store, index, and query semantic memory vectors
  • Canonical env/url contract:
    • MEM0_QDRANT_HOST + MEM0_QDRANT_PORT (OpenClaw .env, gateway runtime context)
    • QDRANT_URL (installer/operator input)
    • compose-mode default in this repository points to host-reachable URL (http://<internal-runtime-redacted>:6333) to avoid loopback drift

Runtime port discovery contract (operator/read-only)​

  • Direction: outgoing
  • Type: CLI
  • Surface: python3 scripts/export_host_runtime_snapshot.py + python3 scripts/validate_runtime_snapshot.py
  • Auth: SSH read-only host access
  • Stability: stable
  • Versioning: snapshot schema 1.0
  • Owner: JaddaHelpifyr/jhf-bobbin
  • Mode: read-only
  • Retry mode: safe rerun
  • Failure mode: live port state cannot be proven and downstream must not assume inferred host ports
  • Purpose: publish observed live host-port bindings for declared dynamic services in a consumer-safe JSON surface:
    • effective.portDiscovery.services.localai
    • effective.portDiscovery.services.qdrant

Optional OpenAI-compatible LLM endpoint​

  • Direction: outgoing
  • Type: REST API
  • Surface: provider-specific OpenAI-compatible LLM endpoint
  • Auth: provider-specific token or key when required
  • Stability: internal
  • Versioning: provider-specific API/version contract; not normalized by this repository beyond OpenAI-compatible request shape
  • Owner: target runtime operator and provider owner
  • Mode: read/write
  • Retry mode: operator config correction or rerun after endpoint recovery
  • Failure mode: degraded capture/recall quality or loss of optional LLM-backed behavior
  • Purpose: support the Mem0 LLM path where configured

Fabric-approved support summary source (contract-only)​

  • Direction: outgoing
  • Type: File contract
  • Surface: approved support-resolution summary objects as defined by Fabric contracts
  • Auth: deployment-specific read contract
  • Stability: internal
  • Versioning: governed by Fabric contract registry (FAB-M1.2) and tenant/retention policy (FAB-M1.10)
  • Owner: Fabric contract owners + operator integrating this tool
  • Mode: read-only
  • Retry mode: idempotent re-evaluation from approved summaries
  • Failure mode: support recall context is omitted; raw support events remain prohibited as fallback
  • Purpose: allow future support recall context from approved summaries only

Dobby marked provenance / memory-enrichment contract (contract-only)​

  • Direction: incoming/outgoing
  • Type: File contract
  • Surface: marked artifact objects (dobby.provenance.memory-enrichment.v1) defined in docs/DOBBY_MARKED_PROVENANCE_CONTRACT.md
  • Auth: deployment-specific read/write contract
  • Stability: internal
  • Versioning: contract versioned by artifact kind (dobby.provenance.memory-enrichment.v1)
  • Owner: producer semantics in JaddaHelpifyr/jhf-dobby, bounded contract surface in JaddaHelpifyr/jhf-bobbin
  • Mode: read/write (bounded)
  • Retry mode: idempotent retry with correlation_id; degraded fallback when Bobbin is unavailable
  • Failure mode: Dobby continues without Bobbin enrichment (dobby-degraded-no-memory-enrichment), and Bobbin must not infer policy/proposal ownership
  • Purpose: allow Bobbin enrichment storage for marked Dobby artifacts without creating second-truth or policy/proposal ownership drift

Fabric combination profiles truth (read-only)​

  • Direction: outgoing
  • Type: REST API
  • Surface: GET api/v1/combinations/profiles
  • Auth: none in current trusted network deployment; deployment-specific auth may be introduced by Fabric owner
  • Stability: internal
  • Versioning: Fabric-owned profile contract; Bobbin consumes read-only and must not reinterpret local truth
  • Owner: JaddaHelpifyr/helpifyr-fabric
  • Mode: read-only
  • Retry mode: retry fetch and keep stale/mismatch state visible
  • Failure mode: stale combination state is visible; standalone fallback remains explicit and non-authoritative for Fabric truth
  • Purpose: consume canonical profile membership for fabric-warp-bobbin, fabric-shuttle-bobbin, fabric-warp-shuttle-bobbin, and bobbin-standalone-openclaw

Fabric governance matrix (Wave-3, read-only)​

  • Direction: outgoing
  • Type: REST API
  • Surface: GET /api/v1/contracts/matrix
  • Auth: none by default, deployment-specific auth possible
  • Stability: internal
  • Versioning: consumed as Fabric-owned matrix_version=1.0.0
  • Owner: JaddaHelpifyr/helpifyr-fabric
  • Mode: read-only
  • Retry mode: fail-fast verify and rerun after Fabric availability recovers
  • Failure mode: governance-family readiness cannot be proven; adoption state is not ready
  • Purpose: consume canonical producer/consumer and accepted-version truth (no local shadow contract truth)

Fabric docs standard contract (Wave-3, read-only)​

  • Direction: outgoing
  • Type: REST API
  • Surface: GET /api/v1/contracts/docs-standard
  • Auth: none by default, deployment-specific auth possible
  • Stability: internal
  • Versioning: consumed as standard_version=1.0.0
  • Owner: JaddaHelpifyr/helpifyr-fabric
  • Mode: read-only
  • Retry mode: fail-fast verify and rerun after Fabric availability recovers
  • Failure mode: docs-governance readiness cannot be proven
  • Purpose: normalize Bobbin docs against Fabric-owned docs standard (without redefining local standard truth)

Fabric summary-export contract surface (Wave-3, read-only)​

  • Direction: outgoing
  • Type: REST API
  • Surface: GET /api/v1/events/summary-exports/contracts
  • Auth: none by default, deployment-specific auth possible
  • Stability: internal
  • Versioning: consumed as contract family fabric-event-spine-summary-export accepted version 1.0.0
  • Owner: JaddaHelpifyr/helpifyr-fabric
  • Mode: read-only
  • Retry mode: fail-fast verify and rerun after Fabric availability recovers
  • Failure mode: summary-export dependency posture is unknown; Bobbin readiness is not green
  • Purpose: make Bobbin summary-export/event dependency explicit and consume Fabric contract truth directly

Fabric memory runtime-claims contract (read-only)​

  • Direction: outgoing
  • Type: REST API
  • Surface: GET /api/v1/memory/runtime-claims/contracts
  • Auth: none by default, deployment-specific auth possible
  • Stability: internal
  • Versioning: consumed as contract family fabric-runtime-memory-authorization-claims accepted version 1.0.0
  • Owner: JaddaHelpifyr/helpifyr-fabric
  • Mode: read-only
  • Retry mode: fail-closed verify and rerun after Fabric availability recovers
  • Failure mode: authorization parity for memory read/write cannot be proven; Bobbin must not invent local claims semantics
  • Purpose: consume canonical actor/tenant/scope/role envelope, keycloak-aligned claim mapping, and normative reason-code taxonomy

Fabric memory runtime-claims readiness (read-only)​

  • Direction: outgoing
  • Type: REST API
  • Surface: GET /api/v1/memory/runtime-claims/readiness
  • Auth: none by default, deployment-specific auth possible
  • Stability: internal
  • Versioning: Fabric-owned readiness contract for the runtime-claims family
  • Owner: JaddaHelpifyr/helpifyr-fabric
  • Mode: read-only
  • Retry mode: fail-closed verify and rerun after Fabric readiness recovers
  • Failure mode: route/readiness parity cannot be proven; fail-closed policy remains active
  • Purpose: verify live route readiness, fail-closed normative posture, reason-code completeness, and conformance example publication

Fabric JARVIS adoption status (read-only)​

  • Direction: outgoing
  • Type: REST API
  • Surface: GET /api/v1/contracts/jarvis
  • Auth: none by default, deployment-specific auth possible
  • Stability: internal
  • Versioning: consumed as family helpifyr-schema-governance-jarvis-adoption-status accepted version 1.0.0
  • Owner: JaddaHelpifyr/helpifyr-fabric
  • Mode: read-only
  • Retry mode: fail-closed verify and rerun after Fabric surface recovery
  • Failure mode: Bobbin cannot prove canonical JARVIS phase truth and must not reconstruct local lifecycle status
  • Purpose: consume canonical M1-M4 phase posture and resolver mapping for core-consumer adoption

Fabric JARVIS readiness/closure posture (read-only)​

  • Direction: outgoing
  • Type: REST API
  • Surface: GET /api/v1/contracts/jarvis/readiness
  • Auth: none by default, deployment-specific auth possible
  • Stability: internal
  • Versioning: Fabric-owned readiness surface for helpifyr-schema-governance-jarvis-adoption-status
  • Owner: JaddaHelpifyr/helpifyr-fabric
  • Mode: read-only
  • Retry mode: fail-closed verify and rerun after Fabric surface recovery
  • Failure mode: Bobbin cannot prove closure posture and must not declare local closure truth
  • Purpose: consume canonical closure posture, blocking refs, and next actions

Fabric contracts registry/families/schemas catalogs (read-only)​

  • Direction: outgoing
  • Type: REST API
  • Surface: GET /api/v1/contracts/registry, GET /api/v1/contracts/families, GET /api/v1/contracts/schemas
  • Auth: none by default, deployment-specific auth possible
  • Stability: internal
  • Versioning: Fabric-owned catalog contracts (registry_version=1.0.0, catalog versions from Fabric)
  • Owner: JaddaHelpifyr/helpifyr-fabric
  • Mode: read-only
  • Retry mode: fail-closed verify and rerun after Fabric catalog surfaces recover
  • Failure mode: Bobbin cannot prove family/schema registration parity for JARVIS core-consumer families
  • Purpose: validate catalog-backed family and schema visibility for the JARVIS adoption-status family and consumed core families

API Typing View​

Exposed APIs​

  • none

Consumed APIs​

  • localai-embeddings

    • Type: rest
    • Stability: stable
    • Auth: none-or-deployment-specific
    • Versioned: false

  • localai-ready

    • Type: rest
    • Stability: stable
    • Auth: none-or-deployment-specific
    • Versioned: false

  • qdrant-http

    • Type: rest
    • Stability: stable
    • Auth: none-or-deployment-specific
    • Versioned: true

  • fabric-contracts-matrix

    • Type: rest
    • Stability: internal
    • Auth: none-or-deployment-specific
    • Versioned: true

  • fabric-contracts-docs-standard

    • Type: rest
    • Stability: internal
    • Auth: none-or-deployment-specific
    • Versioned: true

  • fabric-summary-exports-contracts

    • Type: rest
    • Stability: internal
    • Auth: none-or-deployment-specific
    • Versioned: true

  • fabric-memory-runtime-claims-contracts

    • Type: rest
    • Stability: internal
    • Auth: none-or-deployment-specific
    • Versioned: true

  • fabric-memory-runtime-claims-readiness

    • Type: rest
    • Stability: internal
    • Auth: none-or-deployment-specific
    • Versioned: true

  • fabric-jarvis-contracts

    • Type: rest
    • Stability: internal
    • Auth: none-or-deployment-specific
    • Versioned: true

  • fabric-jarvis-readiness

    • Type: rest
    • Stability: internal
    • Auth: none-or-deployment-specific
    • Versioned: true

  • fabric-contracts-registry

    • Type: rest
    • Stability: internal
    • Auth: none-or-deployment-specific
    • Versioned: true

  • fabric-contracts-families

    • Type: rest
    • Stability: internal
    • Auth: none-or-deployment-specific
    • Versioned: true

  • fabric-contracts-schemas

    • Type: rest
    • Stability: internal
    • Auth: none-or-deployment-specific
    • Versioned: true

CLI And File Contracts​

CLI contracts​

  • bash scripts/bootstrap.sh
  • bash scripts/install_jhf_memory.sh
  • bash scripts/reapply_after_openclaw_update.sh
  • python3 scripts/configure_openclaw_mem0.py
  • python3 scripts/configure_qdrant_collection.py
  • python3 scripts/export-fabric-metadata.py
  • bash scripts/fabric-selfcheck.sh

File contracts​

  • configs/installer.env.example
  • configs/env.mem0.example
  • configs/openclaw.mem0.example.json
  • target host .env
  • target host openclaw.json

Webhooks / Callbacks / Events / MCP​

  • webhooks received: none
  • webhooks emitted: none
  • events consumed: none
  • events published: none
  • MCP endpoints: none

Receive-Side Summary​

  • current receive-side surface: none
  • Fabric cannot currently send commands, callbacks, or subscriptions directly to this repository
  • any future receive-side behavior would need a separate bounded scope and should remain opt-in and non-destructive
  • integrated-mode registration/attachment is represented as read-only metadata contract (runtime.integratedContract) and not as a live command endpoint

Planned Connections​

Host-probed runtime snapshot​

  • Status: implemented as optional operator-run script surface, not in default CI
  • Direction: outgoing
  • Type: Other
  • Surface: operator-driven host probe script output for installed versions, slot state, endpoint availability, and drift signals
  • Auth: operator host access
  • Stability: internal
  • Versioning: repository-defined snapshot schema (schemaVersion)
  • Owner: repository operator
  • Mode: read-only
  • Expected purpose: inspect a live target host for installed versions, slot state, endpoint availability, and drift signals
  • Minimal technical form: script-based operator probe, not a resident API

Stability Notes​

  • OpenClaw file and extension contracts are runtime-critical but partially shaped by upstream changes
  • the community plugin fork is the highest drift-risk connection
  • LocalAI and Qdrant are comparatively stable, but still image/API-version sensitive
  • Fabric-owned policy/governance/claims surfaces are read-only truth; Bobbin-derived outputs are materialized views only and must not become shadow policy truth

AGPLv3. See ../LICENSE (LICENSE).

Learn more at helpifyr.com.