Shared memory and context tools for agentic work.
Code Rooms
<!DOCTYPE HTML>
<html lang="en" class="navy sidebar-visible" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Lifecycle & Administration - m1nd Documentation</title>
<!-- Custom HTML head -->
<meta name="description" content="Complete documentation for m1nd — the local code graph engine for MCP agents">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">
<link rel="icon" href="../favicon-de23e50b.svg">
<link rel="shortcut icon" href="../favicon-8114d1fc.png">
<link rel="stylesheet" href="../css/variables-8adf115d.css">
<link rel="stylesheet" href="../css/general-2459343d.css">
<link rel="stylesheet" href="../css/chrome-ae938929.css">
<link rel="stylesheet" href="../css/print-9e4910d8.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="../fonts/fonts-9644e21d.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" id="mdbook-highlight-css" href="../highlight-493f70e1.css">
<link rel="stylesheet" id="mdbook-tomorrow-night-css" href="../tomorrow-night-4c0ae647.css">
<link rel="stylesheet" id="mdbook-ayu-highlight-css" href="../ayu-highlight-3fdfc3ac.css">
<!-- Custom theme stylesheets -->
<!-- Provide site root and default themes to javascript -->
<script>
const path_to_root = "../";
const default_light_theme = "navy";
const default_dark_theme = "navy";
window.path_to_searchindex_js = "../searchindex-f21ec352.js";
</script>
<!-- Start loading toc.js asap -->
<script src="../toc-a37108d1.js"></script>
</head>
<body>
<div id="mdbook-help-container">
<div id="mdbook-help-popup">
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
<div>
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
<p>Press <kbd>?</kbd> to show this help</p>
<p>Press <kbd>Esc</kbd> to hide this help</p>
</div>
<div id="mdbook-body-container">
<!-- Work around some values being stored in localStorage wrapped in quotes -->
try {
let theme = localStorage.getItem('mdbook-theme');
let sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
} catch (e) { }
<!-- Set the theme before any content is loaded, prevents flash -->
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
let theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
const html = document.documentElement;
html.classList.remove('navy')
html.classList.add(theme);
html.classList.add("js");
<input type="checkbox" id="mdbook-sidebar-toggle-anchor" class="hidden">
<!-- Hide / unhide sidebar before it is displayed -->
let sidebar = null;
const sidebar_toggle = document.getElementById("mdbook-sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
sidebar_toggle.checked = false;
if (sidebar === 'visible') {
sidebar_toggle.checked = true;
html.classList.remove('sidebar-visible');
<nav id="mdbook-sidebar" class="sidebar" aria-label="Table of contents">
<!-- populated by js -->
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript>
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
</noscript>
<div id="mdbook-sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</nav>
<div id="mdbook-page-wrapper" class="page-wrapper">
<div class="page">
<div id="mdbook-menu-bar-hover-placeholder"></div>
<div id="mdbook-menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"/></svg></span>
</label>
<button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list">
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M371.3 367.1c27.3-3.9 51.9-19.4 67.2-42.9L600.2 74.1c12.6-19.5 9.4-45.3-7.6-61.2S549.7-4.4 531.1 9.6L294.4 187.2c-24 18-38.2 46.1-38.4 76.1L371.3 367.1zm-19.6 25.4l-116-104.4C175.9 290.3 128 339.6 128 400c0 3.9 .2 7.8 .6 11.6c1.8 17.5-10.2 36.4-27.8 36.4H96c-17.7 0-32 14.3-32 32s14.3 32 32 32H240c61.9 0 112-50.1 112-112c0-2.5-.1-5-.2-7.5z"/></svg></span>
</button>
<ul id="mdbook-theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-default_theme">Auto</button></li>
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-ayu">Ayu</button></li>
</ul>
<button id="mdbook-search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="mdbook-searchbar">
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352c79.5 0 144-64.5 144-144s-64.5-144-144-144S64 128.5 64 208s64.5 144 144 144z"/></svg></span>
<h1 class="menu-title">m1nd Documentation</h1>
<div class="right-buttons">
<a href="../print.html" title="Print this book" aria-label="Print this book">
<span class=fa-svg id="print-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M128 0C92.7 0 64 28.7 64 64v96h64V64H354.7L384 93.3V160h64V93.3c0-17-6.7-33.3-18.7-45.3L400 18.7C388 6.7 371.7 0 354.7 0H128zM384 352v32 64H128V384 368 352H384zm64 32h32c17.7 0 32-14.3 32-32V256c0-35.3-28.7-64-64-64H64c-35.3 0-64 28.7-64 64v96c0 17.7 14.3 32 32 32H64v64c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V384zm-16-88c-13.3 0-24-10.7-24-24s10.7-24 24-24s24 10.7 24 24s-10.7 24-24 24z"/></svg></span>
</a>
<a href="https://github.com/maxkle1nz/m1nd" title="Git repository" aria-label="Git repository">
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg></span>
<a href="https://github.com/maxkle1nz/m1nd/edit/main/docs/wiki/src/src/api-reference/lifecycle.md" title="Suggest an edit" aria-label="Suggest an edit" rel="edit">
<span class=fa-svg id="git-edit-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M421.7 220.3l-11.3 11.3-22.6 22.6-205 205c-6.6 6.6-14.8 11.5-23.8 14.1L30.8 511c-8.4 2.5-17.5 .2-23.7-6.1S-1.5 489.7 1 481.2L38.7 353.1c2.6-9 7.5-17.2 14.1-23.8l205-205 22.6-22.6 11.3-11.3 33.9 33.9 62.1 62.1 33.9 33.9zM96 353.9l-9.3 9.3c-.9 .9-1.6 2.1-2 3.4l-25.3 86 86-25.3c1.3-.4 2.5-1.1 3.4-2l9.3-9.3H112c-8.8 0-16-7.2-16-16V353.9zM453.3 19.3l39.4 39.4c25 25 25 65.5 0 90.5l-14.5 14.5-22.6 22.6-11.3 11.3-33.9-33.9-62.1-62.1L314.3 67.7l11.3-11.3 22.6-22.6 14.5-14.5c25-25 65.5-25 90.5 0z"/></svg></span>
<div id="mdbook-search-wrapper" class="hidden">
<form id="mdbook-searchbar-outer" class="searchbar-outer">
<div class="search-wrapper">
<input type="search" id="mdbook-searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="mdbook-searchresults-outer" aria-describedby="searchresults-header">
<div class="spinner-wrapper">
<span class=fa-svg id="fa-spin"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M304 48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zm0 416c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM48 304c26.5 0 48-21.5 48-48s-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48zm464-48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM142.9 437c18.7-18.7 18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zm0-294.2c18.7-18.7 18.7-49.1 0-67.9S93.7 56.2 75 75s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zM369.1 437c18.7 18.7 49.1 18.7 67.9 0s18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9z"/></svg></span>
</form>
<div id="mdbook-searchresults-outer" class="searchresults-outer hidden">
<div id="mdbook-searchresults-header" class="searchresults-header"></div>
<ul id="mdbook-searchresults">
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
document.getElementById('mdbook-sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('mdbook-sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#mdbook-sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
<div id="mdbook-content" class="content">
<main>
<h1 id="lifecycle--lock-tools"><a class="header" href="#lifecycle--lock-tools">Lifecycle & Lock Tools</a></h1>
<p>Eight tools for graph ingestion, health monitoring, plan validation, and subgraph locking with change detection.</p>
<hr>
<h2 id="m1ndingest"><a class="header" href="#m1ndingest"><code>m1nd.ingest</code></a></h2>
<p>Ingest or re-ingest a codebase, descriptor, or memory corpus into the graph. This is the primary way to load data into m1nd. Supports three adapters (<code>code</code>, <code>json</code>, <code>memory</code>) and two modes (<code>replace</code>, <code>merge</code>).</p>
<h3 id="parameters"><a class="header" href="#parameters">Parameters</a></h3>
<div class="table-wrapper">
<table>
<thead>
<tr><th>Parameter</th><th>Type</th><th>Required</th><th>Default</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td><code>path</code></td><td><code>string</code></td><td>Yes</td><td>–</td><td>Filesystem path to the source root or memory corpus.</td></tr>
<tr><td><code>agent_id</code></td><td><code>string</code></td><td>Yes</td><td>–</td><td>Calling agent identifier.</td></tr>
<tr><td><code>incremental</code></td><td><code>boolean</code></td><td>No</td><td><code>false</code></td><td>Incremental ingest (code adapter only). Only re-processes files that changed since the last ingest.</td></tr>
<tr><td><code>adapter</code></td><td><code>string</code></td><td>No</td><td><code>"code"</code></td><td>Adapter to use for parsing. Values: <code>"code"</code> (source code – Python, Rust, TypeScript, etc.), <code>"json"</code> (graph snapshot JSON), <code>"memory"</code> (markdown memory corpus).</td></tr>
<tr><td><code>mode</code></td><td><code>string</code></td><td>No</td><td><code>"replace"</code></td><td>How to handle the existing graph. Values: <code>"replace"</code> (clear and rebuild), <code>"merge"</code> (add new nodes/edges into existing graph).</td></tr>
<tr><td><code>namespace</code></td><td><code>string</code></td><td>No</td><td>–</td><td>Optional namespace tag for non-code nodes. Used by <code>memory</code> and <code>json</code> adapters to prefix node external_ids.</td></tr>
</tbody>
</table>
<h3 id="example-request"><a class="header" href="#example-request">Example Request</a></h3>
<pre><code class="language-json">{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "m1nd.ingest",
"arguments": {
"agent_id": "agent-1",
"path": "/path/to/project-f/backend",
"adapter": "code",
"mode": "replace",
"incremental": false
</code></pre>
<h3 id="example-response"><a class="header" href="#example-response">Example Response</a></h3>
"files_processed": 335,
"nodes_created": 9767,
"edges_created": 26557,
"languages": { "python": 335 },
"elapsed_ms": 910.0
<h3 id="adapters"><a class="header" href="#adapters">Adapters</a></h3>
<tr><th>Adapter</th><th>Input</th><th>Node Types</th><th>Edge Types</th></tr>
<tr><td><code>code</code></td><td>Source code directory</td><td>file, class, function, struct, module</td><td>imports, calls, registers, configures, tests, inherits</td></tr>
<tr><td><code>json</code></td><td>Graph snapshot JSON</td><td>(preserved from snapshot)</td><td>(preserved from snapshot)</td></tr>
<tr><td><code>memory</code></td><td>Markdown files</td><td>document, concept, entity</td><td>references, relates_to</td></tr>
<h3 id="mode-behavior"><a class="header" href="#mode-behavior">Mode Behavior</a></h3>
<tr><th>Mode</th><th>Behavior</th></tr>
<tr><td><code>replace</code></td><td>Clears the existing graph, ingests fresh, finalizes (PageRank + CSR). All perspectives and locks are invalidated.</td></tr>
<tr><td><code>merge</code></td><td>Adds new nodes and edges into the existing graph. Existing nodes are updated if they share the same external_id. Graph is re-finalized after merge.</td></tr>
<h3 id="when-to-use"><a class="header" href="#when-to-use">When to Use</a></h3>
<ul>
<li><strong>Session start</strong> – ingest the codebase if the graph is empty or stale</li>
<li><strong>After code changes</strong> – re-ingest incrementally to update the graph</li>
<li><strong>Multi-source</strong> – merge a memory corpus into a code graph for cross-domain queries</li>
<li><strong>Federation preparation</strong> – use <code>m1nd.federate</code> instead for multi-repo ingestion</li>
<h3 id="side-effects"><a class="header" href="#side-effects">Side Effects</a></h3>
<li><strong>replace mode</strong>: clears all graph state, invalidates all perspectives and locks, marks lock baselines as stale</li>
<li><strong>merge mode</strong>: adds to graph, increments graph generation, triggers watcher events on affected locks</li>
<h3 id="related-tools"><a class="header" href="#related-tools">Related Tools</a></h3>
<li><a href="#m1ndhealth"><code>m1nd.health</code></a> – check graph status before deciding to ingest</li>
<li><a href="memory.html#m1nddrift"><code>m1nd.drift</code></a> – see what changed since last session</li>
<li><a href="exploration.html#m1ndfederate"><code>m1nd.federate</code></a> – multi-repo ingestion</li>
<h2 id="m1ndhealth"><a class="header" href="#m1ndhealth"><code>m1nd.health</code></a></h2>
<p>Server health and statistics. Returns node/edge counts, query count, uptime, memory usage, plasticity state, and active sessions.</p>
<h3 id="parameters-1"><a class="header" href="#parameters-1">Parameters</a></h3>
<h3 id="example-request-1"><a class="header" href="#example-request-1">Example Request</a></h3>
"id": 2,
"name": "m1nd.health",
"agent_id": "agent-1"
<h3 id="example-response-1"><a class="header" href="#example-response-1">Example Response</a></h3>
"status": "healthy",
"node_count": 9767,
"edge_count": 26557,
"queries_processed": 142,
"uptime_seconds": 3600.5,
"memory_usage_bytes": 52428800,
"plasticity_state": "active",
"last_persist_time": "2026-03-13T10:30:00Z",
"active_sessions": [
{ "agent_id": "agent-1", "last_active": "2026-03-13T11:25:00Z" }
]
<h3 id="when-to-use-1"><a class="header" href="#when-to-use-1">When to Use</a></h3>
<li><strong>Session start</strong> – first tool to call; verify the server is alive and the graph is loaded</li>
<li><strong>Monitoring</strong> – periodic health checks in long sessions</li>
<li><strong>Debugging</strong> – check memory usage and query counts</li>
<h3 id="related-tools-1"><a class="header" href="#related-tools-1">Related Tools</a></h3>
<li><a href="#m1ndingest"><code>m1nd.ingest</code></a> – load data if the graph is empty</li>
<li><a href="memory.html#m1nddrift"><code>m1nd.drift</code></a> – check what changed since last session</li>
<h2 id="m1ndvalidate_plan"><a class="header" href="#m1ndvalidate_plan"><code>m1nd.validate_plan</code></a></h2>
<p>Validate a proposed modification plan against the code graph. Detects gaps (affected files missing from the plan), risk level, test coverage, and suggested additions. Designed to be called before implementing a plan.</p>
<h3 id="parameters-2"><a class="header" href="#parameters-2">Parameters</a></h3>
<tr><td><code>actions</code></td><td><code>object[]</code></td><td>Yes</td><td>–</td><td>Ordered list of planned actions. Each object has: <code>action_type</code> (string, required – <code>"modify"</code>, <code>"create"</code>, <code>"delete"</code>, <code>"rename"</code>, <code>"test"</code>), <code>file_path</code> (string, required – relative path), <code>description</code> (string, optional), <code>depends_on</code> (string[], optional – other file_paths this action depends on).</td></tr>
<tr><td><code>include_test_impact</code></td><td><code>boolean</code></td><td>No</td><td><code>true</code></td><td>Analyze test coverage for modified files.</td></tr>
<tr><td><code>include_risk_score</code></td><td><code>boolean</code></td><td>No</td><td><code>true</code></td><td>Compute composite risk score.</td></tr>
<h3 id="example-request-2"><a class="header" href="#example-request-2">Example Request</a></h3>
"id": 3,
"name": "m1nd.validate_plan",
"actions": [
{ "action_type": "modify", "file_path": "backend/session_pool.py", "description": "Add connection timeout" },
{ "action_type": "modify", "file_path": "backend/worker_pool.py", "description": "Update pool acquire to use timeout" },
{ "action_type": "test", "file_path": "backend/tests/test_session_pool.py" }
<h3 id="example-response-2"><a class="header" href="#example-response-2">Example Response</a></h3>
"actions_analyzed": 3,
"actions_resolved": 3,
"actions_unresolved": 0,
"gaps": [
{
"file_path": "backend/config.py",
"node_id": "file::config.py",
"reason": "imported by modified file session_pool.py -- timeout config likely needed here",
"severity": "warning",
"signal_strength": 0.72
},
"file_path": "backend/process_manager.py",
"node_id": "file::process_manager.py",
"reason": "in blast radius of worker_pool.py -- calls worker_pool.submit",
"severity": "info",
"signal_strength": 0.45
],
"risk_score": 0.52,
"risk_level": "medium",
"test_coverage": {
"modified_files": 2,
"tested_files": 1,
"untested_files": ["backend/worker_pool.py"],
"coverage_ratio": 0.5
"suggested_additions": [
{ "action_type": "modify", "file_path": "backend/config.py", "reason": "Timeout configuration likely needed" },
{ "action_type": "test", "file_path": "backend/tests/test_worker_pool.py", "reason": "Modified file has no test action in plan" }
"blast_radius_total": 47,
"elapsed_ms": 35.0
<h3 id="risk-levels"><a class="header" href="#risk-levels">Risk Levels</a></h3>
<tr><th>Level</th><th>Score Range</th><th>Meaning</th></tr>
<tr><td><code>"low"</code></td><td>< 0.3</td><td>Small, well-tested change</td></tr>
<tr><td><code>"medium"</code></td><td>0.3 – 0.6</td><td>Moderate scope, some gaps</td></tr>
<tr><td><code>"high"</code></td><td>0.6 – 0.8</td><td>Large scope or missing tests</td></tr>
<tr><td><code>"critical"</code></td><td>>= 0.8</td><td>Very high risk – review carefully</td></tr>
<h3 id="when-to-use-2"><a class="header" href="#when-to-use-2">When to Use</a></h3>
<li><strong>Before implementing</strong> – validate your plan catches all affected files</li>
<li><strong>PR review</strong> – validate that a PR’s changes are complete</li>
<li><strong>Planning</strong> – estimate risk and scope before committing to a plan</li>
<li><strong>Quality gate</strong> – reject plans with risk_score > threshold</li>
<h3 id="related-tools-2"><a class="header" href="#related-tools-2">Related Tools</a></h3>
<li><a href="analysis.html#m1ndimpact"><code>m1nd.impact</code></a> – blast radius for a single node</li>
<li><a href="analysis.html#m1ndpredict"><code>m1nd.predict</code></a> – co-change prediction for a single node</li>
<li><a href="exploration.html#m1ndtrace"><code>m1nd.trace</code></a> – validate a fix plan for a specific error</li>
<h2 id="m1ndlockcreate"><a class="header" href="#m1ndlockcreate"><code>m1nd.lock.create</code></a></h2>
<p>Pin a subgraph region and capture a baseline snapshot for change monitoring. Locks are used to track what changes in a region of the graph while you work. The baseline is compared against the current state when you call <code>lock.diff</code>.</p>
<h3 id="parameters-3"><a class="header" href="#parameters-3">Parameters</a></h3>
<tr><td><code>agent_id</code></td><td><code>string</code></td><td>Yes</td><td>–</td><td>Calling agent identifier. Lock is owned by this agent.</td></tr>
<tr><td><code>scope</code></td><td><code>string</code></td><td>Yes</td><td>–</td><td>Scope type. Values: <code>"node"</code> (single nodes only), <code>"subgraph"</code> (BFS expansion from roots), <code>"query_neighborhood"</code> (nodes matching a query), <code>"path"</code> (ordered node list).</td></tr>
<tr><td><code>root_nodes</code></td><td><code>string[]</code></td><td>Yes</td><td>–</td><td>Root nodes for the lock scope. Non-empty. Matched by external_id (exact), then label, then substring.</td></tr>
<tr><td><code>radius</code></td><td><code>integer</code></td><td>No</td><td>–</td><td>BFS radius for <code>subgraph</code> scope. Range: 1 to 4. Required for subgraph scope.</td></tr>
<tr><td><code>query</code></td><td><code>string</code></td><td>No</td><td>–</td><td>Query string for <code>query_neighborhood</code> scope.</td></tr>
<tr><td><code>path_nodes</code></td><td><code>string[]</code></td><td>No</td><td>–</td><td>Ordered node list for <code>path</code> scope.</td></tr>
<h3 id="scope-types"><a class="header" href="#scope-types">Scope Types</a></h3>
<tr><th>Scope</th><th>Description</th></tr>
<tr><td><code>node</code></td><td>Lock only the specified root nodes</td></tr>
<tr><td><code>subgraph</code></td><td>BFS expansion from root nodes up to <code>radius</code> hops</td></tr>
<tr><td><code>query_neighborhood</code></td><td>Nodes matching a query activation</td></tr>
<tr><td><code>path</code></td><td>An ordered list of nodes forming a path</td></tr>
<h3 id="example-request-3"><a class="header" href="#example-request-3">Example Request</a></h3>
"id": 4,
"name": "m1nd.lock.create",
"scope": "subgraph",
"root_nodes": ["file::chat_handler.py"],
"radius": 2
<h3 id="example-response-3"><a class="header" href="#example-response-3">Example Response</a></h3>
"lock_id": "lock_agent1_001",
"baseline_nodes": 1639,
"baseline_edges": 707,
"graph_generation": 42,
"created_at_ms": 1710300000000
<h3 id="limits"><a class="header" href="#limits">Limits</a></h3>
<li>Max locks per agent: configurable (default: 10)</li>
<li>Max baseline nodes: configurable (default: 5000)</li>
<li>Max baseline edges: configurable (default: 10000)</li>
<li>Total memory budget shared with perspectives</li>
<h3 id="when-to-use-3"><a class="header" href="#when-to-use-3">When to Use</a></h3>
<li><strong>Change monitoring</strong> – lock a region before making changes, then diff to see what changed</li>
<li><strong>Multi-agent coordination</strong> – lock regions to detect when other agents’ changes affect your work</li>
<li><strong>Regression detection</strong> – lock a stable region and watch for unexpected changes</li>
<h3 id="related-tools-3"><a class="header" href="#related-tools-3">Related Tools</a></h3>
<li><a href="#m1ndlockwatch"><code>m1nd.lock.watch</code></a> – set automatic change detection</li>
<li><a href="#m1ndlockdiff"><code>m1nd.lock.diff</code></a> – compute what changed since baseline</li>
<li><a href="#m1ndlockrelease"><code>m1nd.lock.release</code></a> – release the lock when done</li>
<h2 id="m1ndlockwatch"><a class="header" href="#m1ndlockwatch"><code>m1nd.lock.watch</code></a></h2>
<p>Set a watcher strategy on a lock. Watchers determine when the lock automatically detects changes. Without a watcher, you must manually call <code>lock.diff</code>.</p>
<h3 id="parameters-4"><a class="header" href="#parameters-4">Parameters</a></h3>
<tr><td><code>agent_id</code></td><td><code>string</code></td><td>Yes</td><td>–</td><td>Calling agent identifier. Must own the lock.</td></tr>
<tr><td><code>lock_id</code></td><td><code>string</code></td><td>Yes</td><td>–</td><td>Lock to set the watcher on.</td></tr>
<tr><td><code>strategy</code></td><td><code>string</code></td><td>Yes</td><td>–</td><td>Watcher strategy. Values: <code>"manual"</code> (no automatic detection), <code>"on_ingest"</code> (detect after every ingest), <code>"on_learn"</code> (detect after every learn call). Note: <code>"periodic"</code> is not supported in V1.</td></tr>
<h3 id="example-request-4"><a class="header" href="#example-request-4">Example Request</a></h3>
"id": 5,
"name": "m1nd.lock.watch",
"strategy": "on_ingest"
<h3 id="example-response-4"><a class="header" href="#example-response-4">Example Response</a></h3>
"strategy": "on_ingest",
"previous_strategy": null
<h3 id="when-to-use-4"><a class="header" href="#when-to-use-4">When to Use</a></h3>
<li><strong>Automatic monitoring</strong> – set <code>on_ingest</code> to detect changes after every code re-ingest</li>
<li><strong>Learning feedback</strong> – set <code>on_learn</code> to detect when learning shifts edge weights in your region</li>
<li><strong>Manual control</strong> – set <code>manual</code> to disable automatic detection</li>
<h3 id="related-tools-4"><a class="header" href="#related-tools-4">Related Tools</a></h3>
<li><a href="#m1ndlockdiff"><code>m1nd.lock.diff</code></a> – manually trigger a diff (always available regardless of strategy)</li>
<li><a href="#m1ndlockcreate"><code>m1nd.lock.create</code></a> – create the lock first</li>
<h2 id="m1ndlockdiff"><a class="header" href="#m1ndlockdiff"><code>m1nd.lock.diff</code></a></h2>
<p>Compute what changed in a locked region since the baseline was captured. Returns new/removed nodes, new/removed edges, weight changes, and watcher event counts. Fast-path: if the graph generation has not changed, returns immediately with <code>no_changes: true</code>.</p>
<h3 id="parameters-5"><a class="header" href="#parameters-5">Parameters</a></h3>
<tr><td><code>lock_id</code></td><td><code>string</code></td><td>Yes</td><td>–</td><td>Lock to diff.</td></tr>
<h3 id="example-request-5"><a class="header" href="#example-request-5">Example Request</a></h3>
"id": 6,
"name": "m1nd.lock.diff",
"lock_id": "lock_agent1_001"
<h3 id="example-response-changes-detected"><a class="header" href="#example-response-changes-detected">Example Response (changes detected)</a></h3>
"diff": {
"no_changes": false,
"new_nodes": ["file::chat_handler.py::fn::new_method"],
"removed_nodes": [],
"new_edges": ["chat_handler.py|new_method->stream_parser.py|calls"],
"removed_edges": [],
"boundary_edges_added": [],
"boundary_edges_removed": [],
"weight_changes": [
{ "edge_key": "chat_handler.py|stream_parser.py|imports", "old_weight": 0.5, "new_weight": 0.72 }
"baseline_stale": false,
"elapsed_ms": 0.08
"watcher_events_drained": 2,
"rebase_suggested": null
<h3 id="example-response-no-changes"><a class="header" href="#example-response-no-changes">Example Response (no changes)</a></h3>
"no_changes": true,
"new_nodes": [],
"new_edges": [],
"weight_changes": [],
"elapsed_ms": 0.001
"watcher_events_drained": 0,
<h3 id="when-to-use-5"><a class="header" href="#when-to-use-5">When to Use</a></h3>
<li><strong>After ingest</strong> – check if your locked region was affected</li>
<li><strong>After learning</strong> – check if feedback shifted weights in your region</li>
<li><strong>Periodic check</strong> – poll for changes during long sessions</li>
<li><strong>Before committing</strong> – verify no unexpected changes in the region</li>
<h3 id="related-tools-5"><a class="header" href="#related-tools-5">Related Tools</a></h3>
<li><a href="#m1ndlockrebase"><code>m1nd.lock.rebase</code></a> – re-capture baseline after acknowledging changes</li>
<h2 id="m1ndlockrebase"><a class="header" href="#m1ndlockrebase"><code>m1nd.lock.rebase</code></a></h2>
<p>Re-capture the lock baseline from the current graph without releasing the lock. Use this after calling <code>lock.diff</code> and acknowledging the changes – the new baseline becomes the reference for future diffs.</p>
<h3 id="parameters-6"><a class="header" href="#parameters-6">Parameters</a></h3>
<tr><td><code>lock_id</code></td><td><code>string</code></td><td>Yes</td><td>–</td><td>Lock to rebase.</td></tr>
<h3 id="example-request-6"><a class="header" href="#example-request-6">Example Request</a></h3>
"id": 7,
"name": "m1nd.lock.rebase",
<h3 id="example-response-5"><a class="header" href="#example-response-5">Example Response</a></h3>
"previous_generation": 42,
"new_generation": 45,
"baseline_nodes": 1645,
"baseline_edges": 712,
"watcher_preserved": true
<h3 id="when-to-use-6"><a class="header" href="#when-to-use-6">When to Use</a></h3>
<li><strong>After acknowledging changes</strong> – rebase after reviewing a diff to reset the baseline</li>
<li><strong>After stale warning</strong> – when <code>lock.diff</code> returns <code>baseline_stale: true</code>, rebase to fix it</li>
<li><strong>Periodic refresh</strong> – rebase periodically in long sessions to keep baselines current</li>
<h3 id="related-tools-6"><a class="header" href="#related-tools-6">Related Tools</a></h3>
<li><a href="#m1ndlockdiff"><code>m1nd.lock.diff</code></a> – the diff that triggers a rebase</li>
<li><a href="#m1ndlockcreate"><code>m1nd.lock.create</code></a> – creating a new lock is an alternative to rebasing</li>
<h2 id="m1ndlockrelease"><a class="header" href="#m1ndlockrelease"><code>m1nd.lock.release</code></a></h2>
<p>Release a lock and free its resources. Removes the lock state, cleans up pending watcher events, and frees memory. Irreversible.</p>
<h3 id="parameters-7"><a class="header" href="#parameters-7">Parameters</a></h3>
<tr><td><code>lock_id</code></td><td><code>string</code></td><td>Yes</td><td>–</td><td>Lock to release.</td></tr>
<h3 id="example-request-7"><a class="header" href="#example-request-7">Example Request</a></h3>
"id": 8,
"name": "m1nd.lock.release",
<h3 id="example-response-6"><a class="header" href="#example-response-6">Example Response</a></h3>
"released": true
<h3 id="when-to-use-7"><a class="header" href="#when-to-use-7">When to Use</a></h3>
<li><strong>Done monitoring</strong> – release when you no longer need change detection</li>
<li><strong>Memory pressure</strong> – locks consume memory proportional to baseline size</li>
<li><strong>Session end</strong> – release all locks before ending a session</li>
<li><strong>Automatic</strong>: locks are also cascade-released when their associated perspective is closed via <code>perspective.close</code></li>
<h3 id="related-tools-7"><a class="header" href="#related-tools-7">Related Tools</a></h3>
<li><a href="#m1ndlockcreate"><code>m1nd.lock.create</code></a> – create a new lock</li>
<li><a href="perspectives.html#m1ndperspectiveclose"><code>m1nd.perspective.close</code></a> – cascade-releases associated locks</li>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../api-reference/perspectives.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
<a rel="next prefetch" href="../tutorials/quickstart.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
<div style="clear: both"></div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../api-reference/perspectives.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<a rel="next prefetch" href="../tutorials/quickstart.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<template id=fa-eye><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M288 32c-80.8 0-145.5 36.8-192.6 80.6C48.6 156 17.3 208 2.5 243.7c-3.3 7.9-3.3 16.7 0 24.6C17.3 304 48.6 356 95.4 399.4C142.5 443.2 207.2 480 288 480s145.5-36.8 192.6-80.6c46.8-43.5 78.1-95.4 93-131.1c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C433.5 68.8 368.8 32 288 32zM432 256c0 79.5-64.5 144-144 144s-144-64.5-144-144s64.5-144 144-144s144 64.5 144 144zM288 192c0 35.3-28.7 64-64 64c-11.5 0-22.3-3-31.6-8.4c-.2 2.8-.4 5.5-.4 8.4c0 53 43 96 96 96s96-43 96-96s-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6z"/></svg></span></template>
<template id=fa-eye-slash><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M38.8 5.1C28.4-3.1 13.3-1.2 5.1 9.2S-1.2 34.7 9.2 42.9l592 464c10.4 8.2 25.5 6.3 33.7-4.1s6.3-25.5-4.1-33.7L525.6 386.7c39.6-40.6 66.4-86.1 79.9-118.4c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C465.5 68.8 400.8 32 320 32c-68.2 0-125 26.3-169.3 60.8L38.8 5.1zM223.1 149.5C248.6 126.2 282.7 112 320 112c79.5 0 144 64.5 144 144c0 24.9-6.3 48.3-17.4 68.7L408 294.5c5.2-11.8 8-24.8 8-38.5c0-53-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6c0 10.2-2.4 19.8-6.6 28.3l-90.3-70.8zm223.1 298L373 389.9c-16.4 6.5-34.3 10.1-53 10.1c-79.5 0-144-64.5-144-144c0-6.9 .5-13.6 1.4-20.2L83.1 161.5C60.3 191.2 44 220.8 34.5 243.7c-3.3 7.9-3.3 16.7 0 24.6c14.9 35.7 46.2 87.7 93 131.1C174.5 443.2 239.2 480 320 480c47.8 0 89.9-12.9 126.2-32.5z"/></svg></span></template>
<template id=fa-copy><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M502.6 70.63l-61.25-61.25C435.4 3.371 427.2 0 418.7 0H255.1c-35.35 0-64 28.66-64 64l.0195 256C192 355.4 220.7 384 256 384h192c35.2 0 64-28.8 64-64V93.25C512 84.77 508.6 76.63 502.6 70.63zM464 320c0 8.836-7.164 16-16 16H255.1c-8.838 0-16-7.164-16-16L239.1 64.13c0-8.836 7.164-16 16-16h128L384 96c0 17.67 14.33 32 32 32h47.1V320zM272 448c0 8.836-7.164 16-16 16H63.1c-8.838 0-16-7.164-16-16L47.98 192.1c0-8.836 7.164-16 16-16H160V128H63.99c-35.35 0-64 28.65-64 64l.0098 256C.002 483.3 28.66 512 64 512h192c35.2 0 64-28.8 64-64v-32h-47.1L272 448z"/></svg></span></template>
<template id=fa-play><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M73 39c-14.8-9.1-33.4-9.4-48.5-.9S0 62.6 0 80V432c0 17.4 9.4 33.4 24.5 41.9s33.7 8.1 48.5-.9L361 297c14.3-8.7 23-24.2 23-41s-8.7-32.2-23-41L73 39z"/></svg></span></template>
<template id=fa-clock-rotate-left><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M75 75L41 41C25.9 25.9 0 36.6 0 57.9V168c0 13.3 10.7 24 24 24H134.1c21.4 0 32.1-25.9 17-41l-30.8-30.8C155 85.5 203 64 256 64c106 0 192 86 192 192s-86 192-192 192c-40.8 0-78.6-12.7-109.7-34.4c-14.5-10.1-34.4-6.6-44.6 7.9s-6.6 34.4 7.9 44.6C151.2 495 201.7 512 256 512c141.4 0 256-114.6 256-256S397.4 0 256 0C185.3 0 121.3 28.7 75 75zm181 53c-13.3 0-24 10.7-24 24V256c0 6.4 2.5 12.5 7 17l72 72c9.4 9.4 24.6 9.4 33.9 0s9.4-24.6 0-33.9l-65-65V152c0-13.3-10.7-24-24-24z"/></svg></span></template>
window.playground_copyable = true;
<script src="../elasticlunr-ef4e11c1.min.js"></script>
<script src="../mark-09e88c2c.min.js"></script>
<script src="../searcher-c2a407aa.js"></script>
<script src="../clipboard-1626706a.min.js"></script>
<script src="../highlight-abc7f01d.js"></script>
<script src="../book-a0b12cfe.js"></script>
<!-- Custom JS scripts -->
</body>
</html>
