mcp-vue-codegen 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 anshu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# mcp-vue-codegen
+
+MCP Server，根据数据库表字段 JSON 文档自动生成 Vue3 前端 CRUD 模块代码。
+
+## 生成文件
+
+- `options.ts` — 表单字段配置、过滤类型
+- `api/*.ts` — 5 个标准 CRUD 接口
+- `index.vue` — 列表页（表格、搜索、按钮、分页、工作流）
+- `form.vue` — 表单页（折叠面板、字段控件、校验规则、主从表）
+
+## 使用方式
+
+### npx 直接运行
+
+```bash
+npx mcp-vue-codegen
+```
+
+### IDE 配置
+
+在 Claude Code 的 MCP 设置中添加：
+
+```json
+{
+  "mcpServers": {
+    "vue-codegen": {
+      "command": "npx",
+      "args": ["-y", "mcp-vue-codegen"]
+    }
+  }
+}
+```
+
+## MCP Tools
+
+### validate_schema
+
+校验 JSON 文档是否符合规范。
+
+| 参数 | 类型 | 说明 |
+|------|------|------|
+| schemaJson | string | JSON 文档内容 |
+
+### generate_vue_crud
+
+根据 JSON 文档生成完整 CRUD 代码。
+
+| 参数 | 类型 | 说明 |
+|------|------|------|
+| schemaJson | string | JSON 文档内容 |
+| outputDir | string | 输出目录路径 |
+
+## JSON 文档格式
+
+```json
+{
+  "module": {
+    "moduleName": "oa",
+    "businessName": "企业证照借用",
+    "entityName": "CertBorrow",
+    "apiBasePath": "/oa/certBorrow",
+    "permissionPrefix": "oa_OaCertificatesBorrow",
+    "hasWorkflow": true,
+    "hasExport": true,
+    "hasPrint": true
+  },
+  "master": {
+    "tableName": "oa_cert_borrow",
+    "formSections": [...],
+    "fields": [...]
+  },
+  "detail": {
+    "tableName": "oa_cert_borrow_detail",
+    "fields": [...]
+  }
+}
+```
+
+## License
+
+MIT

package/build/generators/api.d.ts

@@ -0,0 +1,3 @@
+import { TableSchema } from '../types/schema.js';
+export declare function generateApi(schema: TableSchema): string;
+//# sourceMappingURL=api.d.ts.map

package/build/generators/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/generators/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,wBAAgB,WAAW,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAEvD"}

package/build/generators/api.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateApi = generateApi;
+const api_tpl_js_1 = require("../templates/api.tpl.js");
+function generateApi(schema) {
+    return (0, api_tpl_js_1.generateApiTemplate)(schema);
+}
+//# sourceMappingURL=api.js.map

package/build/generators/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/generators/api.ts"],"names":[],"mappings":";;AAGA,kCAEC;AAJD,wDAA8D;AAE9D,SAAgB,WAAW,CAAC,MAAmB;IAC7C,OAAO,IAAA,gCAAmB,EAAC,MAAM,CAAC,CAAC;AACrC,CAAC"}

package/build/generators/form-vue.d.ts

@@ -0,0 +1,3 @@
+import { TableSchema } from '../types/schema.js';
+export declare function generateFormVue(schema: TableSchema): string;
+//# sourceMappingURL=form-vue.d.ts.map

package/build/generators/form-vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-vue.d.ts","sourceRoot":"","sources":["../../src/generators/form-vue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,wBAAgB,eAAe,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAE3D"}

package/build/generators/form-vue.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateFormVue = generateFormVue;
+const form_vue_tpl_js_1 = require("../templates/form-vue.tpl.js");
+function generateFormVue(schema) {
+    return (0, form_vue_tpl_js_1.generateFormVueTemplate)(schema);
+}
+//# sourceMappingURL=form-vue.js.map

package/build/generators/form-vue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-vue.js","sourceRoot":"","sources":["../../src/generators/form-vue.ts"],"names":[],"mappings":";;AAGA,0CAEC;AAJD,kEAAuE;AAEvE,SAAgB,eAAe,CAAC,MAAmB;IACjD,OAAO,IAAA,yCAAuB,EAAC,MAAM,CAAC,CAAC;AACzC,CAAC"}

package/build/generators/index-vue.d.ts

@@ -0,0 +1,3 @@
+import { TableSchema } from '../types/schema.js';
+export declare function generateIndexVue(schema: TableSchema): string;
+//# sourceMappingURL=index-vue.d.ts.map

package/build/generators/index-vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-vue.d.ts","sourceRoot":"","sources":["../../src/generators/index-vue.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAE5D"}

package/build/generators/index-vue.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateIndexVue = generateIndexVue;
+const index_vue_tpl_js_1 = require("../templates/index-vue.tpl.js");
+function generateIndexVue(schema) {
+    return (0, index_vue_tpl_js_1.generateIndexVueTemplate)(schema);
+}
+//# sourceMappingURL=index-vue.js.map

package/build/generators/index-vue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-vue.js","sourceRoot":"","sources":["../../src/generators/index-vue.ts"],"names":[],"mappings":";;AAGA,4CAEC;AAJD,oEAAyE;AAEzE,SAAgB,gBAAgB,CAAC,MAAmB;IAClD,OAAO,IAAA,2CAAwB,EAAC,MAAM,CAAC,CAAC;AAC1C,CAAC"}

package/build/generators/options.d.ts

@@ -0,0 +1,3 @@
+import { TableSchema } from '../types/schema.js';
+export declare function generateOptions(schema: TableSchema): string;
+//# sourceMappingURL=options.d.ts.map

package/build/generators/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/generators/options.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD,wBAAgB,eAAe,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAE3D"}

package/build/generators/options.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateOptions = generateOptions;
+const options_tpl_js_1 = require("../templates/options.tpl.js");
+function generateOptions(schema) {
+    return (0, options_tpl_js_1.generateOptionsTemplate)(schema);
+}
+//# sourceMappingURL=options.js.map

package/build/generators/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../src/generators/options.ts"],"names":[],"mappings":";;AAGA,0CAEC;AAJD,gEAAsE;AAEtE,SAAgB,eAAe,CAAC,MAAmB;IACjD,OAAO,IAAA,wCAAuB,EAAC,MAAM,CAAC,CAAC;AACzC,CAAC"}

package/build/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/build/index.js

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const mcp_js_1 = require("@modelcontextprotocol/sdk/server/mcp.js");
+const stdio_js_1 = require("@modelcontextprotocol/sdk/server/stdio.js");
+const zod_1 = require("zod");
+const validate_js_1 = require("./tools/validate.js");
+const generate_js_1 = require("./tools/generate.js");
+const server = new mcp_js_1.McpServer({
+    name: 'mcp-vue-codegen',
+    version: '1.0.0',
+});
+// Tool 1: validate_schema
+server.tool('validate_schema', '校验 JSON 文档是否符合 Vue3 CRUD 代码生成规范', {
+    schemaJson: zod_1.z.string().describe('JSON 文档内容（字符串）'),
+}, async ({ schemaJson }) => {
+    const result = (0, validate_js_1.validateSchema)(schemaJson);
+    if (result.valid) {
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: '✅ JSON 文档校验通过，可以用于代码生成。',
+                },
+            ],
+        };
+    }
+    return {
+        content: [
+            {
+                type: 'text',
+                text: `❌ JSON 文档校验失败：\n${result.errors.map((e, i) => `${i + 1}. ${e}`).join('\n')}`,
+            },
+        ],
+    };
+});
+// Tool 2: generate_vue_crud
+server.tool('generate_vue_crud', '根据 JSON 文档生成完整的 Vue3 CRUD 模块代码（index.vue、form.vue、options.ts、api/*.ts）', {
+    schemaJson: zod_1.z.string().describe('JSON 文档内容（字符串）'),
+    outputDir: zod_1.z.string().describe('输出目录路径'),
+}, async ({ schemaJson, outputDir }) => {
+    const result = await (0, generate_js_1.generateVueCrud)(schemaJson, outputDir);
+    if (result.success) {
+        const fileList = result.files
+            .map(f => `  - ${f.path} (${f.lines} 行) — ${f.description}`)
+            .join('\n');
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: `✅ 代码生成成功！\n\n生成文件列表：\n${fileList}`,
+                },
+            ],
+        };
+    }
+    return {
+        content: [
+            {
+                type: 'text',
+                text: `❌ 代码生成失败：${result.error}`,
+            },
+        ],
+    };
+});
+// Start the server
+async function main() {
+    const transport = new stdio_js_1.StdioServerTransport();
+    await server.connect(transport);
+}
+main().catch((error) => {
+    console.error('Server error:', error);
+    process.exit(1);
+});
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAEA,oEAAoE;AACpE,wEAAiF;AACjF,6BAAwB;AACxB,qDAAqD;AACrD,qDAAsD;AAEtD,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC;IAC3B,IAAI,EAAE,iBAAiB;IACvB,OAAO,EAAE,OAAO;CACjB,CAAC,CAAC;AAEH,0BAA0B;AAC1B,MAAM,CAAC,IAAI,CACT,iBAAiB,EACjB,iCAAiC,EACjC;IACE,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;CAClD,EACD,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;IACvB,MAAM,MAAM,GAAG,IAAA,4BAAc,EAAC,UAAU,CAAC,CAAC;IAC1C,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE,yBAAyB;iBAChC;aACF;SACF,CAAC;IACJ,CAAC;IACD,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAe;gBACrB,IAAI,EAAE,mBAAmB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;aACpF;SACF;KACF,CAAC;AACJ,CAAC,CACF,CAAC;AAEF,4BAA4B;AAC5B,MAAM,CAAC,IAAI,CACT,mBAAmB,EACnB,wEAAwE,EACxE;IACE,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC;IACjD,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;CACzC,EACD,KAAK,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,EAAE;IAClC,MAAM,MAAM,GAAG,MAAM,IAAA,6BAAe,EAAC,UAAU,EAAE,SAAS,CAAC,CAAC;IAC5D,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK;aAC1B,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,WAAW,EAAE,CAAC;aAC3D,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAe;oBACrB,IAAI,EAAE,yBAAyB,QAAQ,EAAE;iBAC1C;aACF;SACF,CAAC;IACJ,CAAC;IACD,OAAO;QACL,OAAO,EAAE;YACP;gBACE,IAAI,EAAE,MAAe;gBACrB,IAAI,EAAE,YAAY,MAAM,CAAC,KAAK,EAAE;aACjC;SACF;KACF,CAAC;AACJ,CAAC,CACF,CAAC;AAEF,mBAAmB;AACnB,KAAK,UAAU,IAAI;IACjB,MAAM,SAAS,GAAG,IAAI,+BAAoB,EAAE,CAAC;IAC7C,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;AAClC,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;IACrB,OAAO,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC;IACtC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/build/templates/api.tpl.d.ts

@@ -0,0 +1,3 @@
+import { TableSchema } from '../types/schema.js';
+export declare function generateApiTemplate(schema: TableSchema): string;
+//# sourceMappingURL=api.tpl.d.ts.map

package/build/templates/api.tpl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.tpl.d.ts","sourceRoot":"","sources":["../../src/templates/api.tpl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAiD/D"}

package/build/templates/api.tpl.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateApiTemplate = generateApiTemplate;
+function generateApiTemplate(schema) {
+    const basePath = schema.module.apiBasePath;
+    return `import request from '/@/utils/request'
+
+// 列表查询
+export function fetchList(query?: Object) {
+  return request({
+    url: '${basePath}/page',
+    method: 'get',
+    params: query
+  })
+}
+
+// 新增单条数据
+export function addObj(obj?: Object) {
+  return request({
+    url: '${basePath}',
+    method: 'post',
+    data: obj
+  })
+}
+
+// 获取单条数据
+export function getObj(id?: string) {
+  return request({
+    url: '${basePath}/' + id,
+    method: 'get'
+  })
+}
+
+// 删除多条数据
+export function delObjs(ids?: Object) {
+  return request({
+    url: '${basePath}/removeByIds',
+    method: 'post',
+    data: ids
+  })
+}
+
+// 修改数据
+export function putObj(obj?: Object) {
+  return request({
+    url: '${basePath}/updateById',
+    method: 'post',
+    data: obj
+  })
+}
+`;
+}
+//# sourceMappingURL=api.tpl.js.map

package/build/templates/api.tpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.tpl.js","sourceRoot":"","sources":["../../src/templates/api.tpl.ts"],"names":[],"mappings":";;AAEA,kDAiDC;AAjDD,SAAgB,mBAAmB,CAAC,MAAmB;IACrD,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC;IAE3C,OAAO;;;;;YAKG,QAAQ;;;;;;;;;YASR,QAAQ;;;;;;;;;YASR,QAAQ;;;;;;;;YAQR,QAAQ;;;;;;;;;YASR,QAAQ;;;;;CAKnB,CAAC;AACF,CAAC"}

package/build/templates/form-vue.tpl.d.ts

@@ -0,0 +1,3 @@
+import { TableSchema } from '../types/schema.js';
+export declare function generateFormVueTemplate(schema: TableSchema): string;
+//# sourceMappingURL=form-vue.tpl.d.ts.map

package/build/templates/form-vue.tpl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-vue.tpl.d.ts","sourceRoot":"","sources":["../../src/templates/form-vue.tpl.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAyB,MAAM,oBAAoB,CAAC;AAiMxE,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,CAykBnE"}