Integrations

Foundation ready · production embeds coming soon

Bring companions into your product.

Mod-Mate is being shaped to power side panels, inline assistants, dashboard helpers, documentation companions, and custom API integrations inside host apps.

Phase 2 UI preview

No auth, tokens, billing, or real installs yet.

Embed surfaces

Choose where the companion lives

These are planned surfaces for host apps. Phase 1 defines the foundation; production embedding comes later.

Coming Soon

Floating Widget

A small companion launcher that can sit above any product screen.

Best for: Lightweight support, onboarding, and quick help.

Foundation Ready

Side Panel

A persistent companion beside the active workflow or editor.

Best for: Writing tools, QA workflows, dashboards, and admin screens.

Planned

Inline Panel

A companion placed directly inside a form, document, or workflow section.

Best for: Field-level help, review steps, and guided edits.

Planned

Full Page

A complete hosted companion experience for deeper testing or internal tools.

Best for: Standalone copilots, testing surfaces, and team workflows.

Planned

Custom Surface

A host-defined placement that uses the same context and runtime contract.

Best for: Specialized products that need their own UI shell.

Integration options

Generic ways products can use Mod-Mate

Public-facing integrations stay generic. These cards describe the future shape without pretending anything is installed yet.

React Widget

Coming Soon

Drop a companion into any React app with a themeable chat surface.

Custom Web App

Coming Soon

Embed a companion inside your own web app with a small JavaScript snippet.

Product Dashboard

Planned

Add an in-product companion to dashboards, settings, or onboarding flows.

Documentation Site

Planned

Plug a support companion into your docs that answers from your own pages.

Internal Tool

Planned

Bring a companion into a private team tool — back-office, admin, ops.

API Integration

Planned

REST contract for talking to any Mod-Mate companion from any backend.

SDK

Coming Soon

A first-class SDK for embedding and orchestrating companions in code.

Runtime flow

How host apps will talk to Mod-Mate

The integration model is simple: host-owned context in, companion response out, user-confirmed actions only.

Host app identifies itself

The host sends its app ID, version, environment, and intended embed surface.

Host sends context packet

The host app chooses the active screen, selected text, memory sections, warnings, and action hints.

Mod-Mate runs the companion

The runtime combines the companion profile, context packet, message, and history.

User confirms write actions

Host apps apply changes only after confirmation. No silent writes, no hidden mutations.

Safety & control

No silent writes. No hidden data grabs.

The host app stays in control of source data and applies changes only after user confirmation.

Host apps own source data and decide what context is safe to send.
Mod-Mate owns profile execution, runtime prompting, warnings, and response shape.
Write-like actions require confirmation before the host app changes anything.
Secrets, tokens, credentials, and unrelated private data should never be sent.

Integration keys, token issuing, auth, billing, workspaces, and real host-app write actions are intentionally not part of this UI pass.

Developer preview

Planned embed config shape

This mirrors the Phase 1 foundation types. It is a preview, not a live SDK or install snippet.

const embedConfig = {
  hostApp: {
    id: "custom",
    name: "Your App",
    environment: "production",
  },
  surface: "side-panel",
  companionProfileId: "your-companion-id",
  defaultRuntimeMode: "live",
  defaultProvider: "openai",
  allowHostActions: true,
};

Preview only — no token generation, install flow, or script loader exists yet.

Proof integrations

Developer samples in this repo

These samples prove the same integration foundation can support a writing app and a QA workflow app without making the public product all about our internal projects.

Developer sample

Writing app sample

Shows how a story editor could send scene, Story Bible, character, canon, and Never Break context.

src/lib/integrationSamples/masterDraftAdapter.ts

docs/integrations/master-draft-contract.md

Developer sample

QA workflow sample

Shows how a QA product could send active workflow, source input, generated output, Project Brain, risks, and Jira/TestRail state.

src/lib/integrationSamples/qatalystAdapter.ts

docs/integrations/qatalyst-contract.md