@alfe.ai/mcp-bundler 0.3.2 → 0.4.1

package/README.md

@@ -10,6 +10,32 @@ Part of [**Alfe**](https://alfe.ai) — the operating system for AI agents: buil
 npm install @alfe.ai/mcp-bundler
 ```
 
+## Runtime model
+
+`Store` is the owner-only on-disk source of truth, `Manager` serializes
+configuration mutations and reconciles them into a live `McpBundler`, and the
+bundler supervises child connections while exposing one collision-safe tool
+catalogue. Tool listing and routing use the same resolved catalogue, so every
+advertised name is callable.
+
+The store and child MCP protocol are executable-data boundaries:
+configuration, catalogues, schemas, arguments, results, stderr, and errors are
+validated and bounded. Existing malformed stores fail closed instead of being
+replaced with an empty registry. Store files are read without following
+symlinks and are tightened to owner-only permissions.
+
+```typescript
+import { Manager, McpBundler } from '@alfe.ai/mcp-bundler';
+
+const bundler = new McpBundler();
+const manager = new Manager();
+await manager.loadIntoBundler(bundler);
+await manager.addServer(
+  { command: 'npx', args: ['-y', 'example-mcp'] },
+  { id: 'example', owner: 'manual' },
+);
+```
+
 ## Links
 
 - 🌐 Website: <https://alfe.ai>