worsoft-frontend-codegen-local-mcp 0.1.20 → 0.1.22

package/MVP_DESIGN.md

@@ -2,25 +2,30 @@
 
 ## Goal
 
-Build a parallel MCP plugin that generates frontend files from:
-- local Markdown design docs
+Build a local MCP plugin that generates frontend files from:
+
+- API-first structured metadata
 - local template assets
 - style-based template selection
 
-without depending on the Worsoft backend generation API.
-
-## First Supported Flow
-
-1. Read `designFile` or fall back to `plugins/sql/SQL 设计说明.md`
-2. Parse one table definition by `tableName`
-3. Load style metadata from `assets/style-catalog.json`
-4. Resolve the shared template selection for the requested `style`
-5. Build a normalized metadata model
-6. For `master_child_jump`, infer the child relation from the design doc when possible
-7. Map parsed fields into simple frontend field types
-8. Render plugin-local runtime templates when the style is implemented
-9. Return a render manifest
-10. Optionally write files
+without depending on the Worsoft backend generation API
+
+## Current Supported Flow
+
+1. Caller-side skill reads API doc and requirement doc
+2. Caller-side skill builds structured metadata
+3. MCP receives:
+   - main table metadata
+   - child table metadata
+   - explicit `payloadField`
+   - field arrays
+4. MCP loads style metadata from `assets/style-catalog.json`
+5. MCP resolves shared template selection for the requested `style`
+6. MCP builds a normalized runtime model
+7. MCP maps structured fields into frontend field types
+8. MCP renders runtime templates
+9. MCP returns a render manifest
+10. MCP optionally writes files
 
 ## Declared Styles
 
@@ -38,19 +43,34 @@ without depending on the Worsoft backend generation API.
 
 ```json
 {
-  "tableName": "iwm_sys_trade",
-  "className": "IwmSysTrade",
-  "functionName": "iwmSysTrade",
-  "moduleName": "admin/test",
-  "pk": { "fieldName": "id", "attrName": "id" },
+  "featureTitle": "外包人员登记",
+  "tableName": "iwm_emp_outsource_person",
+  "tableComment": "外包人员登记表",
+  "apiPath": "iwmEmpOutsourcePerson",
+  "style": "master_child_jump",
   "fields": [
     {
-      "fieldName": "trade_name",
-      "attrName": "tradeName",
-      "sqlType": "VARCHAR",
-      "comment": "Trade Name",
-      "formType": "text",
-      "isAudit": false
+      "fieldName": "name",
+      "label": "姓名",
+      "type": "String",
+      "required": true,
+      "readonly": false,
+      "show": true,
+      "length": 30,
+      "dictType": "",
+      "description": "姓名",
+      "sourceKind": "entity"
+    }
+  ],
+  "children": [
+    {
+      "childTableName": "iwm_emp_outsource_person_certificate",
+      "childTableComment": "外包人员证书表",
+      "payloadField": "certificateList",
+      "mainField": "id",
+      "childField": "outsourcePersonId",
+      "relationType": "1:N",
+      "fields": []
     }
   ]
 }
@@ -58,21 +78,20 @@ without depending on the Worsoft backend generation API.
 
 ## Master-Child Contract
 
-When `style=master_child_jump`, local mode now prefers the Markdown design file contract:
-- parse child relations from the "主从表关联说明" section
-- auto-resolve `mainField` and `childField`
-- require `childTableName` only when one main table has multiple child relations
+When `style=master_child_jump`:
+
+- MCP never infers child relations
+- caller must always pass explicit `children[]`
+- `payloadField` is the only child list truth
 
 ## Risks
 
-- Existing shared templates use Velocity syntax and need a larger rendering engine.
-- Markdown design docs may drift from the real schema if they are not maintained.
-- Query/list/form metadata inference is heuristic in local mode.
-- Multi-child relations still need explicit disambiguation.
+- Quality now depends on caller-side extraction from API doc and requirement doc
+- If API doc omits structure or dict codes, caller-side skill must stop and report the gap
+- Query/list/form metadata inference still contains heuristics for widths and control defaults
 
 ## Next Steps
 
-1. Add query/grid heuristics
-2. Add dict config sidecar file support
-3. Decide whether to migrate shared templates into a neutral local template format
-4. Consider cross-checking Markdown definitions against SQL or DB metadata
+1. Continue hardening API-first extraction rules on caller-side skills
+2. Expand structured validation for field completeness
+3. Keep template behavior aligned with API-first contract

package/README.md

@@ -1,30 +1,29 @@
 # Worsoft Frontend Codegen Local MCP
 
-This MCP generates Worsoft frontend files from a local Markdown design document.
+This MCP generates Worsoft frontend files from API-first structured metadata.
 
 ## Scope
 
-- local Markdown design file input
+- API-first structured input
 - style-based template selection
 - local template rendering
 - single-table runtime generation
-- master-child runtime generation with caller-provided relation input
+- master-child runtime generation with explicit `children[]`
 - optional write-to-disk
 
 ## Current Inputs
 
-- `designFile`: optional, defaults to `../sql/SQL 设计说明.md`
+- `featureTitle`
 - `tableName`
+- `tableComment`
+- `apiPath`
 - `style`
+- `fields`
+- `children`
 - `frontendPath`
 - `moduleName`
 - `writeToDisk`
 - `overwrite`
-- `childTableName` when `style=master_child_jump`: required
-- `mainField` when `style=master_child_jump`: required
-- `childField` when `style=master_child_jump`: required
-- `relationType` when `style=master_child_jump`: optional
-- `children` when `style=master_child_jump`: optional array of direct child relations; when provided it overrides the legacy single-child fields
 
 ## Recommended MCP Arguments
 
@@ -32,9 +31,17 @@ Single table:
 
 ```json
 {
-  "tableName": "iwm_sys_trade",
+  "featureTitle": "劳务公司管理",
+  "tableName": "iwm_out_labor_company",
+  "tableComment": "劳务公司信息表",
+  "apiPath": "iwmOutLaborCompany",
   "style": "single_table_dialog",
-  "designFile": "plugins/sql/SQL 设计说明.md",
+  "fields": [
+    { "fieldName": "id", "label": "主键", "type": "Long", "show": false },
+    { "fieldName": "companyName", "label": "劳务公司名称", "type": "String", "required": true, "length": 120 },
+    { "fieldName": "status", "label": "状态", "type": "String", "dictType": "labor_company_status", "length": 32 }
+  ],
+  "children": [],
   "frontendPath": "E:/own-worker-platform/trunk/worsoft-ui",
   "moduleName": "admin/test",
   "writeToDisk": false
@@ -45,40 +52,30 @@ Master-child:
 
 ```json
 {
-  "tableName": "iwm_sys_trade",
-  "style": "master_child_jump",
-  "childTableName": "iwm_sys_trade_level",
-  "mainField": "id",
-  "childField": "trade_id",
-  "relationType": "1:N",
-  "designFile": "plugins/sql/SQL 设计说明.md",
-  "frontendPath": "E:/own-worker-platform/trunk/worsoft-ui",
-  "moduleName": "admin/test",
-  "writeToDisk": false
-}
-```
-
-Multi direct children on one main form:
-
-```json
-{
-  "tableName": "iwm_sys_trade_level",
+  "featureTitle": "外包人员登记",
+  "tableName": "iwm_emp_outsource_person",
+  "tableComment": "外包人员登记表",
+  "apiPath": "iwmEmpOutsourcePerson",
   "style": "master_child_jump",
+  "fields": [
+    { "fieldName": "id", "label": "主键", "type": "Long", "show": false },
+    { "fieldName": "name", "label": "姓名", "type": "String", "required": true, "length": 30 },
+    { "fieldName": "employeeStatus", "label": "人员状态", "type": "String", "dictType": "employee_status", "length": 32 }
+  ],
   "children": [
     {
-      "childTableName": "iwm_sys_trade_level_standard",
+      "childTableName": "iwm_emp_outsource_person_certificate",
+      "childTableComment": "外包人员证书表",
+      "payloadField": "certificateList",
       "mainField": "id",
-      "childField": "trade_level_id",
-      "relationType": "1:N"
-    },
-    {
-      "childTableName": "iwm_sys_trade_level_competency",
-      "mainField": "id",
-      "childField": "trade_level_id",
-      "relationType": "1:N"
+      "childField": "outsourcePersonId",
+      "relationType": "1:N",
+      "fields": [
+        { "fieldName": "id", "label": "主键", "type": "Long", "show": false },
+        { "fieldName": "certificateId", "label": "证件名称ID", "type": "Long", "required": true }
+      ]
     }
   ],
-  "designFile": "plugins/sql/SQL 璁捐璇存槑.md",
   "frontendPath": "E:/own-worker-platform/trunk/worsoft-ui",
   "moduleName": "admin/test",
   "writeToDisk": false
@@ -92,9 +89,7 @@ PowerShell:
 ```powershell
 powershell -ExecutionPolicy Bypass -File plugins/worsoft-codegen-local/smoke_test_mcp.ps1 -Scenario single
 powershell -ExecutionPolicy Bypass -File plugins/worsoft-codegen-local/smoke_test_mcp.ps1 -Scenario master
-powershell -ExecutionPolicy Bypass -File plugins/worsoft-codegen-local/smoke_test_mcp.ps1 -Scenario child
 powershell -ExecutionPolicy Bypass -File plugins/worsoft-codegen-local/smoke_test_mcp.ps1 -Scenario multi
-powershell -ExecutionPolicy Bypass -File plugins/worsoft-codegen-local/smoke_test_mcp.ps1 -Scenario missing_relation
 ```
 
 Node:
@@ -102,42 +97,33 @@ Node:
 ```bash
 node plugins/worsoft-codegen-local/smoke_test_mcp.js --scenario single
 node plugins/worsoft-codegen-local/smoke_test_mcp.js --scenario master
-node plugins/worsoft-codegen-local/smoke_test_mcp.js --scenario child
 node plugins/worsoft-codegen-local/smoke_test_mcp.js --scenario multi
-node plugins/worsoft-codegen-local/smoke_test_mcp.js --scenario missing_relation
 ```
 
 Optional overrides:
 
-- `--design-file`
 - `--table-name`
+- `--table-comment`
+- `--feature-title`
+- `--api-path`
 - `--style`
-- `--child-table-name`
-- `--main-field`
-- `--child-field`
-- `--relation-type`
 - `--frontend-path`
 - `--write-to-disk`
 
 ## Master-Child Contract
 
-For `master_child_jump`, MCP does not infer relations from the design file anymore.
-
-The caller must provide:
+For `master_child_jump`, MCP does not infer relations.
 
-- either `children[]`
-- or the legacy single-child fields: `childTableName`, `mainField`, `childField`
+The caller must provide explicit `children[]`, and each child must include:
 
-If these fields are missing, MCP returns `relation_input_required`.
+- `childTableName`
+- `childTableComment`
+- `payloadField`
+- `mainField`
+- `childField`
+- `fields`
 
-Example:
-
-```json
-{
-  "type": "relation_input_required",
-  "requiredFields": ["childTableName", "mainField", "childField"]
-}
-```
+If these fields are missing, MCP returns a structured validation error.
 
 ## Current Outputs
 
@@ -145,6 +131,7 @@ Example:
 - `src/views/<module>/<function>/form.vue`
 - `src/views/<module>/<function>/options.ts`
 - `src/api/<module>/<function>.ts`
+- `src/i18n/biz/<module>/<function>.zh-cn.ts`
 - `menu/<function>_menu.sql`
 
 ## Style Catalog
@@ -160,12 +147,11 @@ Declared styles:
 
 ## Notes
 
-- Shared Worsoft template references live under `../template`.
-- Plugin-local runtime assets live under `assets/templates`.
-- The preferred source is `plugins/sql/SQL 设计说明.md`.
-- Markdown parsing is used for field-definition tables.
-- Master-child relation parsing is handled outside MCP and passed in through tool arguments.
-- Menu SQL is emitted to `frontendPath/menu/`.
+- Shared Worsoft template references live under `../template`
+- Plugin-local runtime assets live under `assets/templates`
+- API-first means MCP no longer reads Markdown design docs or SQL design docs
+- Caller-side skills are responsible for turning API doc + requirement doc into structured arguments
+- Menu SQL is emitted to `frontendPath/menu/`
 
 ## IDE Guide