@deppon/deppon-prd-mcp 0.1.0

package/README.md

@@ -0,0 +1,83 @@
+# @deppon/deppon-prd-mcp
+
+私有化 **PRD 生成 + 交互原型** MCP 服务，基于仓库内 `deppon-prd-generator` skill 模板。
+
+## 功能
+
+1. **Web 控制台**（`http://127.0.0.1:3847`）：填写 PRD 要素（标题、背景、筛选字段、列表列等）→ 生成标准化 `prd.md`
+2. **原型生成**：根据同一套配置生成 Tailwind 高保真 `prototype.html`（含 PRD § 标注弹框）
+3. **在线动态调整**：原型 iframe 支持 `?edit=1` 直接改标题等文案；Studio 侧可改工具栏/行操作并实时预览
+4. **MCP 工具**：供 Cursor Agent 调用 `generate_prd`、`generate_prototype`、`open_prd_studio` 等
+
+## 安装（消费方）
+
+```bash
+npm install -g @deppon/deppon-prd-mcp
+# 或无需全局安装，直接在 MCP 配置里用 npx
+```
+
+## 快速开始
+
+```bash
+# 仅 Web 控制台
+npx @deppon/deppon-prd-mcp --web-only
+
+# MCP + Web（供 AI 工具 stdio 调用时自动拉起 Web）
+npx @deppon/deppon-prd-mcp
+```
+
+浏览器打开 Web 控制台：**http://127.0.0.1:3847**
+
+## Cursor / Claude Desktop MCP 配置
+
+```json
+{
+  "mcpServers": {
+    "deppon-prd": {
+      "command": "npx",
+      "args": ["-y", "@deppon/deppon-prd-mcp@latest"],
+      "env": {
+        "DEPPON_PRD_WORKSPACE": "/绝对路径/到你的项目根目录",
+        "DEPPON_PRD_HTTP_PORT": "3847"
+      }
+    }
+  }
+}
+```
+
+> monorepo 内开发时可改用本地路径：`"command": "node", "args": ["packages/deppon-prd-mcp/dist/cli.js"]`
+
+## 发布（维护方）
+
+```bash
+cd packages/deppon-prd-mcp
+npm run build
+npm run publish:auto
+```
+
+## 输出目录
+
+```
+src/prototypes/<slug>/
+├── project.config.json   # 结构化配置（可 round-trip 编辑）
+├── prd.md                  # 标准化 PRD（默认 DP-IT 标题）
+└── prototype.html          # 可交互原型
+```
+
+## MCP 工具
+
+| 工具 | 说明 |
+|------|------|
+| `generate_prd` | 从 pageName 等要素生成 PRD 并落盘 |
+| `generate_prototype` | 从已有 slug 重新生成 prototype.html |
+| `list_prd_projects` | 列出已生成项目 |
+| `get_prd_project` | 读取项目配置与 PRD 摘要 |
+| `open_prd_studio` | 返回 Web 控制台 URL |
+
+## 环境变量
+
+| 变量 | 默认 | 说明 |
+|------|------|------|
+| `DEPPON_PRD_WORKSPACE` | `process.cwd()` | 仓库根目录 |
+| `DEPPON_PRD_HTTP_PORT` | `3847` | Web 控制台端口 |
+| `DEPPON_PRD_HTTP_HOST` | `127.0.0.1` | 绑定地址 |

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+import { startMcpServer } from './mcp/server.js';
+import { startWebOnly } from './http/server.js';
+const webOnly = process.argv.includes('--web-only');
+if (webOnly) {
+    startWebOnly().catch(err => {
+        console.error('[deppon-prd-mcp] fatal:', err);
+        process.exit(1);
+    });
+}
+else {
+    startMcpServer().catch(err => {
+        console.error('[deppon-prd-mcp] fatal:', err);
+        process.exit(1);
+    });
+}

package/dist/config.d.ts

@@ -0,0 +1,8 @@
+export declare function getPackageRoot(): string;
+export declare function getTemplatesRoot(): string;
+export declare function getWebRoot(): string;
+export declare function getWorkspaceRoot(): string;
+export declare function getPrototypesRoot(): string;
+export declare function getHttpPort(): number;
+export declare function getHttpHost(): string;
+export declare function getHttpBaseUrl(): string;

package/dist/config.js

@@ -0,0 +1,30 @@
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const PKG_ROOT = path.resolve(__dirname, '..');
+export function getPackageRoot() {
+    return PKG_ROOT;
+}
+export function getTemplatesRoot() {
+    return path.join(PKG_ROOT, 'templates');
+}
+export function getWebRoot() {
+    return path.join(PKG_ROOT, 'web');
+}
+export function getWorkspaceRoot() {
+    return process.env.DEPPON_PRD_WORKSPACE || process.cwd();
+}
+export function getPrototypesRoot() {
+    return path.join(getWorkspaceRoot(), 'src/prototypes');
+}
+export function getHttpPort() {
+    const raw = process.env.DEPPON_PRD_HTTP_PORT || '3847';
+    const port = Number.parseInt(raw, 10);
+    return Number.isFinite(port) ? port : 3847;
+}
+export function getHttpHost() {
+    return process.env.DEPPON_PRD_HTTP_HOST || '127.0.0.1';
+}
+export function getHttpBaseUrl() {
+    return `http://${getHttpHost()}:${getHttpPort()}`;
+}

package/dist/core/prd-generator.d.ts

@@ -0,0 +1,4 @@
+import { type PrdProject } from './types.js';
+export declare function generatePrdMarkdown(project: PrdProject): string;
+export declare function getTemplatePath(project: PrdProject): string | null;
+export declare function getExamplePrototypePath(project: PrdProject): string | null;

package/dist/core/prd-generator.js

@@ -0,0 +1,133 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { getTemplatesRoot } from '../config.js';
+import { buildDpItTitle, EXAMPLE_MAP, TEMPLATE_MAP } from './types.js';
+export function generatePrdMarkdown(project) {
+    const title = project.useDpItTitle ? buildDpItTitle(project) : `${project.pageName} PRD（产品需求文档）`;
+    const moduleName = project.pageName;
+    const listTitle = `${moduleName.replace(/列表|管理/g, '').trim() || moduleName}列表`;
+    const featureRows = project.features
+        .map(f => `| ${f.module} | ${f.feature} | ${f.description} |`)
+        .join('\n');
+    const permissionRows = project.permissions
+        .map(p => `| ${p.point} | ${p.scope} | ${p.dataScope} |`)
+        .join('\n');
+    const filterRows = project.filters
+        .map(f => `| ${f.name} | ${f.type} | ${f.limit} | ${f.matchRule} |`)
+        .join('\n');
+    const columnRows = project.columns
+        .map(c => `| ${c.name} | ${c.description || '—'} | ${c.sortable ? '是' : '否'} |`)
+        .join('\n');
+    const toolbarText = project.toolbarButtons.map(b => `「${b}」`).join('、');
+    const rowActionText = project.rowActions.map(a => `**${a}**`).join('、');
+    const crudSections = project.enableCrud
+        ? `
+### 3.2.1 列表工具栏（表头操作区）
+
+- **位置**：列表卡片顶部与表格之间；左侧为「${listTitle}」；右侧为 ${toolbarText}。
+- **禁止**：与页面 H1 并排；默认不与筛选区「查询 / 重置」混排。
+
+### 4. ${moduleName}详情（只读）
+
+- 行内「查看」打开只读弹层，展示主字段。
+- 关闭后回到列表，不刷新分页位置（除非业务要求）。
+
+### 5. 新增 / 编辑表单
+
+- **入口**：表头「${project.createButtonLabel || `新建${moduleName}`}」或行内「编辑」。
+- **校验**：必填项、格式与长度按字段定义；提交成功后 Toast 提示并刷新列表（原型 mock）。
+
+### 6. 删除
+
+- 行内「删除」二次确认；确认后移除（原型 mock）。
+`
+        : `
+> **本期说明**：无新建 / 编辑 / 删除弹层，仅筛选 + 分页列表。
+`;
+    return `# ${title}
+
+> **交互原型**：[打开 prototype.html](./prototype.html)（须 **HTTP** 打开 \`src/prototypes/${project.slug}/\` 目录。）
+
+> **生成说明**：由 @deppon/deppon-prd-mcp 基于 deppon-prd-generator skill 模板生成。
+
+---
+
+## 1. 引言
+
+### 1.1 背景
+
+${project.background}
+
+### 1.2 功能清单
+
+| 模块 | 功能点 | 功能描述 |
+| ---- | ------ | -------- |
+${featureRows}
+
+---
+
+## 2. 页面菜单与权限规划
+
+### 2.1 页面菜单
+
+**菜单路径**：${project.menuPath}
+
+### 2.2 权限规划
+
+| 权限点 | 操作范围 | 数据范围 |
+| ------ | -------- | -------- |
+${permissionRows}
+
+---
+
+## 3. ${moduleName}需求说明
+
+### 3.1 筛选查询区
+
+变更筛选后点击「查询」刷新列表并回到第 1 页；「重置」清空条件。
+
+| 筛选字段 | 类型 | 输入限制 | 匹配规则 |
+| :------- | :--- | :------- | :------- |
+${filterRows}
+
+- **查询** / **重置**：筛选卡片底部仅放查询、重置。
+
+### 3.2 数据列表
+
+| 列表字段 | 字段说明 | 排序 |
+| :------- | :------- | :--- |
+${columnRows}
+
+- **分页**：默认 10 条；可切换 10 / 20 / 50。
+- **行操作**：${rowActionText}。
+${crudSections}
+---
+
+## 9. 原型与 PRD 对应关系
+
+| 原型区域 | PRD 章节 |
+| -------- | -------- |
+| 页眉标题 | §1 |
+| 筛选区 | §3.1 |
+| 列表与工具栏 | §3.2 |
+${project.enableCrud ? '| 详情弹层 | §4 |\n| 表单弹层 | §5 |\n| 删除确认 | §6 |' : ''}
+
+---
+
+## 修订记录
+
+| 版本 | 日期 | 说明 |
+| ---- | ---- | ---- |
+| 1.0 | ${project.batchDate || '—'} | MCP 初版生成 |
+`;
+}
+export function getTemplatePath(project) {
+    const file = TEMPLATE_MAP[project.pageType];
+    const full = path.join(getTemplatesRoot(), 'template', file);
+    return fs.existsSync(full) ? full : null;
+}
+export function getExamplePrototypePath(project) {
+    const dir = EXAMPLE_MAP[project.pageType];
+    const full = path.join(getTemplatesRoot(), 'examples', dir, 'prototype.html');
+    return fs.existsSync(full) ? full : null;
+}

package/dist/core/project-store.d.ts

@@ -0,0 +1,23 @@
+import { type PrdProject } from './types.js';
+export declare function getProjectDir(slug: string): string;
+export declare function listProjects(): Array<{
+    slug: string;
+    pageName: string;
+    updatedAt: string;
+}>;
+export declare function loadProject(slug: string): PrdProject | null;
+export declare function saveProject(project: PrdProject): {
+    slug: string;
+    prdPath: string;
+    prototypePath: string;
+    configPath: string;
+};
+export declare function applyOverrides(slug: string, overrides: Partial<Pick<PrdProject, 'pageName' | 'background' | 'mockRows'>> & {
+    listTitle?: string;
+    filterTitle?: string;
+}): PrdProject | null;
+export declare function readProjectFiles(slug: string): {
+    prd: string;
+    prototype: string;
+    config: PrdProject;
+} | null;

package/dist/core/project-store.js

@@ -0,0 +1,77 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { getPrototypesRoot } from '../config.js';
+import { generatePrdMarkdown } from './prd-generator.js';
+import { generatePrototypeHtml } from './prototype-generator.js';
+import { PrdProjectSchema } from './types.js';
+const CONFIG_FILE = 'project.config.json';
+export function getProjectDir(slug) {
+    return path.join(getPrototypesRoot(), slug);
+}
+export function listProjects() {
+    const root = getPrototypesRoot();
+    if (!fs.existsSync(root))
+        return [];
+    return fs
+        .readdirSync(root, { withFileTypes: true })
+        .filter(d => d.isDirectory())
+        .map(d => {
+        const dir = path.join(root, d.name);
+        const configPath = path.join(dir, CONFIG_FILE);
+        let pageName = d.name;
+        if (fs.existsSync(configPath)) {
+            try {
+                const cfg = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+                pageName = cfg.pageName || pageName;
+            }
+            catch {
+                /* ignore */
+            }
+        }
+        const stat = fs.statSync(dir);
+        return { slug: d.name, pageName, updatedAt: stat.mtime.toISOString() };
+    })
+        .sort((a, b) => b.updatedAt.localeCompare(a.updatedAt));
+}
+export function loadProject(slug) {
+    const configPath = path.join(getProjectDir(slug), CONFIG_FILE);
+    if (!fs.existsSync(configPath))
+        return null;
+    return PrdProjectSchema.parse(JSON.parse(fs.readFileSync(configPath, 'utf8')));
+}
+export function saveProject(project) {
+    const parsed = PrdProjectSchema.parse(project);
+    const dir = getProjectDir(parsed.slug);
+    fs.mkdirSync(dir, { recursive: true });
+    const prdPath = path.join(dir, 'prd.md');
+    const prototypePath = path.join(dir, 'prototype.html');
+    const configPath = path.join(dir, CONFIG_FILE);
+    fs.writeFileSync(configPath, JSON.stringify(parsed, null, 2), 'utf8');
+    fs.writeFileSync(prdPath, generatePrdMarkdown(parsed), 'utf8');
+    fs.writeFileSync(prototypePath, generatePrototypeHtml(parsed), 'utf8');
+    return { slug: parsed.slug, prdPath, prototypePath, configPath };
+}
+export function applyOverrides(slug, overrides) {
+    const project = loadProject(slug);
+    if (!project)
+        return null;
+    if (overrides.pageName)
+        project.pageName = overrides.pageName;
+    if (overrides.background)
+        project.background = overrides.background;
+    if (overrides.mockRows)
+        project.mockRows = overrides.mockRows;
+    saveProject(project);
+    return project;
+}
+export function readProjectFiles(slug) {
+    const project = loadProject(slug);
+    if (!project)
+        return null;
+    const dir = getProjectDir(slug);
+    return {
+        config: project,
+        prd: fs.readFileSync(path.join(dir, 'prd.md'), 'utf8'),
+        prototype: fs.readFileSync(path.join(dir, 'prototype.html'), 'utf8'),
+    };
+}

package/dist/core/prototype-generator.d.ts

@@ -0,0 +1,2 @@
+import { type PrdProject } from './types.js';
+export declare function generatePrototypeHtml(project: PrdProject): string;