Appearance
mmune documentation
mmune watches the data systems in your estate, maps how they connect, and tells you when something drifts, breaks or goes out of compliance. It connects out to your systems read-only. It does not sit in your data path, and it does not intercept or change the data that flows between them.
These docs cover three audiences. Pick the section that matches what you are doing.
I use the mmune web console
Start with Concepts, which explains the vocabulary and walks through the first fifteen minutes. Then read the page for the area you are working in.
| Console page | Guide | What you do there |
|---|---|---|
Dashboard (/) | Dashboard | Read the health score, the top issues and the summary tiles |
Alerts (/alerts) | Alerts | Work the event feed and incidents, set up ticketing |
Data (/data) | Data Explorer | Onboard integrations, read lineage, review mappings, duplicates, findings and reconciliation |
Compliance (/compliance) | Compliance | Review security findings, compliance frameworks, the audit report and the license |
Workspace (/workspace) | Workspace | Chat with the agents, run workflows, control autonomy and spend, read logs |
Signing in, roles and license states are in Account and access. If you install and run mmune yourself, the settings you can change are in the Configuration reference.
The screenshots in these pages show sample data. Your installation shows your own estate.
I am integrating another system with mmune through the API
Read the API overview first. It covers the base URL, authentication, roles, errors, rate limits and how long-running jobs are polled. The reference pages group the routers by purpose, and each endpoint has a curl example plus Python and TypeScript examples for the main workflows.
| Reference page | What it covers |
|---|---|
| Integrations and discovery | Integrations, OAuth, discovery, projects, probes |
| Mapping, lineage and semantic | Mapping, lineage, semantic, duplicates, recommendations, reconciliation, analysis |
| Health and monitoring | Health, monitoring, watchdog, drift, healing, containment, incidents, events, notifications, ticketing, stats, dashboard, logs |
| Security and platform | Auth, audit, Guardian, compliance, masking, license, reports |
| Agents and workflows | Agents, workflows, workflow templates, RAG, orchestration, state and cancellation |
| WebSockets and streaming | WebSocket and server-sent-event endpoints |
To receive events from mmune or push data into it, read Webhooks and events. It lists what mmune sends today, including the limits you should plan around.
I am building an AI agent that uses mmune
Read AI agents. It covers the mmune-trust MCP server and its tools, which REST endpoints are safe for an agent to call, and a capabilities table that maps tasks to endpoints. A machine-readable index of every page here is in llms.txt.
Conventions in these docs
Examples use the host https://mmune.example.com. Replace it with the address of your installation. Secrets and tokens appear as placeholders such as <TOKEN>, and example sign-ins use you@example.com.