MirrorNeuron Component Guide
Map the MirrorNeuron workspace to the component responsible for a change.
MirrorNeuron Component Guide
The MirrorNeuron workspace is a collection of focused components. Use this guide to find the right owner, the smallest relevant validation command, and the public documentation page to update when behavior changes.
Workspace Map
| Folder | Responsibility | Basic validation |
|---|---|---|
MirrorNeuron | Elixir/OTP runtime, scheduling, persistence, clustering, and gRPC services. | mix test |
mn-deploy | Installer, local services, Docker Compose runtime, and release support. | ./install.sh --help |
mn-cli | The mn command-line interface. | python3 -m pytest -q |
mn-api | FastAPI REST gateway over the runtime SDK. | python3 -m pytest -q |
mn-python-sdk | Python client, bundle helpers, and shared runtime configuration. | python3 -m pytest -q |
mn-web-ui | Browser dashboard for jobs, graphs, and run state. | npm run lint && npm test -- --run |
mn-agents | Shared agent templates used by blueprints. | Component test suite |
mn-skills | Reusable Python skill packages. | Package-specific tests |
mn-system-tests | Cross-component smoke, integration, and end-to-end tests. | python3 test_all.py --fast |
Membrane | Context engine, context-memory SDK, and compression tooling. | cargo test and package tests |
otterdesk-blueprints | Self-contained OtterDesk-facing worker blueprints. | Blueprint-specific validation |
otterdesk-desktop-app | Electron desktop application for launching and monitoring blueprints. | npm run doctor |
Local Runtime Path
Install the editable workspace runtime through the deployment component:
cd mn-deploy
./install.sh --mode localStart and inspect it:
mn runtime start
mn runtime health
mn node listWhich Documentation to Read
- Runtime and scheduling changes: Runtime Architecture, Reliability Guide, and Cluster Architecture.
- CLI or API changes: CLI Reference, API Reference, and Environment Variables.
- Blueprint behavior: Blueprints and Skills, Blueprint Standard, and Examples.
- Installation, service, model, or OpenShell changes: Installation, Model Runtime, and Docker and OpenShell for Blueprints.
- Cross-component changes: Testing and Contributing.
Documentation Rules
Keep public pages task-focused and implementation-backed. Update commands, ports, configuration names, and examples in the same change that alters their behavior. Do not publish agent instructions, release procedures, temporary templates, or obsolete architecture diagrams as product documentation.