@akanjs/cli 2.2.10-rc.1 → 2.2.11

package/README.md

@@ -37,6 +37,21 @@ akan create-module <module-name>
 akan create-scalar <scalar-name>
 ```
 
+## Agent And MCP Commands
+
+```bash
+akan context --format markdown
+akan context --format json --module <module-name>
+akan doctor --format json
+akan guideline list
+akan guideline show framework
+akan agent install cursor
+akan mcp
+```
+
+These commands expose Akan workspace structure, module abstracts, diagnostics, and guideline instructions for
+coding agents. The MCP server is read-only and is intended to provide context rather than edit files directly.
+
 Package maintenance commands are also exposed through the same executable:
 
 ```bash

package/guidelines/moduleOverview/moduleOverview.instruction.md

@@ -4,6 +4,7 @@
 Use this before generating or reviewing a database module. It defines which file owns which responsibility and in what order a module should grow.
 
 ## Ownership
+- `model.abstract.md` describes business intent, durable domain rules, workflows, and agent notes that are not obvious from code.
 - `model.constant.ts` defines business data shape, model layers, enums, field options, resolved values, and small type helpers.
 - `model.dictionary.ts` defines user-facing labels, descriptions, endpoint text, slice text, errors, and UI strings.
 - `model.document.ts` defines persistence behavior: filters, document methods, model helpers, indexes, and schema hooks.
@@ -13,7 +14,8 @@ Use this before generating or reviewing a database module. It defines which file
 - `Model.Template.tsx`, `Model.Unit.tsx`, `Model.View.tsx`, `Model.Util.tsx`, and `Model.Zone.tsx` render forms, list items, detail views, controls, and page sections.
 
 ## Current Akan Patterns
-- For a new model, read and generate in this order: constant, dictionary, document, service, signal, store, UI.
+- For a new model, read and generate in this order: abstract, constant, dictionary, document, service, signal, store, UI.
+- Before changing an existing module, read `model.abstract.md` first when it exists.
 - For a list page, inspect signal slice, store, Zone, then Unit.
 - For detail or edit UI, inspect signal view/endpoint, store, Zone/View, then Template.
 - For a user action, design service behavior first, then signal endpoint, store action, and Util or Template control.
@@ -23,6 +25,8 @@ Use this before generating or reviewing a database module. It defines which file
 - Do not hide business rules inside React render functions.
 - Do not copy model shapes by hand across files; rely on generated types and helpers.
 - Keep scanner-friendly names exactly aligned with the module name and PascalCase component name.
+- Update `model.abstract.md` when business invariants, workflows, or public behavior change.
+- Do not update `model.abstract.md` for formatting-only, import-only, or style-only changes.
 
 ## Review Checklist
 - The instruction points to current docs pages, not removed docs routes.