mcp-feature-doc-generator 1.0.3 → 1.0.4

package/dist/analysis/feature-context.js

@@ -58,9 +58,10 @@ export function collectFeatureDocContext(rawFeaturePath, promptText, workspaceRo
     const apiImports = unique(insights.flatMap((item) => item.apiImports));
     const dictImports = unique(insights.flatMap((item) => item.dictImports));
     const permissionTokens = unique(insights.flatMap((item) => item.permissionTokens));
+    const outputPath = `开发规范/views/${featurePath}-README.md`;
     const renderedText = renderContextBundle({
         featurePath,
-        outputPath: `开发规范/views/${featurePath}-README.md`,
+        outputPath,
         promptText,
         insights,
         componentNames,
@@ -72,7 +73,7 @@ export function collectFeatureDocContext(rawFeaturePath, promptText, workspaceRo
     return {
         featurePath,
         featureDir,
-        outputPath: `开发规范/views/${featurePath}-README.md`,
+        outputPath,
         promptText,
         featureFiles: featureFiles.map((filePath) => toRepoPath(filePath, workspaceRoot)),
         dependencyFiles: dependencyFiles.map((filePath) => toRepoPath(filePath, workspaceRoot)),

package/dist/index.js

@@ -5,7 +5,7 @@ import { z } from "zod";
 import { collectFeatureDocContext } from "./analysis/feature-context.js";
 import { PROMPT_DESCRIPTION, PROMPT_NAME, buildPromptMessages, } from "./prompts/generate-feature-doc.js";
 import { getTemplateContent } from "./resources/template.js";
-const SERVER_VERSION = "1.0.2";
+const SERVER_VERSION = "1.0.4";
 const FEATURE_PATH_DESCRIPTION = "功能路径，如 project/pmbasupplierevaluation 或 pm/ba/PmBaRentcontractSettle";
 const server = new McpServer({
     name: "feature-doc-generator",

package/dist/prompts/generate-feature-doc.js

@@ -3,23 +3,25 @@ export const PROMPT_NAME = "generate_feature_doc";
 export const PROMPT_DESCRIPTION = "为指定的 Vue 3 业务功能路径生成功能说明文档";
 export function buildPromptMessages(featurePath) {
     const templateContent = getTemplateContent();
+    const bt = "`";
+    const fence = "```";
     const promptText = `# 任务说明
 
 ## 任务
-根据**我指定的功能路径**，为 \`src/views/${featurePath}\` 下对应业务功能生成功能说明文档。
+根据**我指定的功能路径**，为 ${bt}src/views/${featurePath}${bt} 下对应业务功能生成功能说明文档。
 
-**仅处理我明确提供的功能路径**，不自动扫描整个 \`src/views/\`，不按目录逐个遍历。
+**仅处理我明确提供的功能路径**，不自动扫描整个 ${bt}src/views/${bt}，不按目录逐个遍历。
 
-如果指定功能的 \`index.vue\`、\`form.vue\` 或其他核心业务页面中引入了其他**业务功能页面/业务模块**，需将这些**直接引用的相关业务功能**一并纳入分析范围。
+如果指定功能的 ${bt}index.vue${bt}、${bt}form.vue${bt} 或其他核心业务页面中引入了其他**业务功能页面/业务模块**，需将这些**直接引用的相关业务功能**一并纳入分析范围。
 
 ---
 
 ## 模板要求
-严格按照 \`开发规范/功能说明模板.md\` 的 8 个章节结构输出：
+严格按照 ${bt}开发规范/功能说明模板.md${bt} 的 8 个章节结构输出：
 
 1. 功能概述（核心作用 + 业务场景）
 2. 前置数据（数据来源表格 + 前置条件）
-3. 业务流程（\`mermaid graph LR\`）
+3. 业务流程（${bt}mermaid graph LR${bt}）
 4. 核心业务逻辑（数据联动、计算规则、状态流转等，按需分节）
 5. 后续数据使用（生成的数据表格 + 使用场景）
 6. 引用组件说明（关键公共/私有组件及配置）
@@ -30,10 +32,10 @@ export function buildPromptMessages(featurePath) {
 
 ## 功能路径输入规则
 - 以**我指定的路径**为准
-- 路径必须是 \`src/views/\` 下的具体功能目录
+- 路径必须是 ${bt}src/views/${bt} 下的具体功能目录
 - 一次可输入一个或多个功能路径
 - **优先分析指定路径本身**
-- **不自动扫描整个 \`src/views/\`**
+- **不自动扫描整个 ${bt}src/views/${bt}**
 - **不按叶子目录批量遍历**
 - 如果指定路径无效，需明确说明原因，例如：
   - 路径不存在
@@ -46,8 +48,8 @@ export function buildPromptMessages(featurePath) {
 ## 功能依赖扩展规则
 若指定功能目录下以下文件中：
 
-- \`index.vue\`
-- \`form.vue\`
+- ${bt}index.vue${bt}
+- ${bt}form.vue${bt}
 - 其他核心业务页面文件
 
 存在对其他**业务功能页面/业务模块**的引入、嵌套、弹窗承载、抽屉承载、tab 承载、步骤流承载或局部业务集成，则需将这些**直接引用的业务功能**纳入说明范围。
@@ -70,7 +72,7 @@ export function buildPromptMessages(featurePath) {
 - 通用 hooks / utils / constants
 - 无独立业务语义的局部片段组件
 - 以下组件**强制忽略**，不分析、不说明、最终文档中不得出现：
-  \`microme-operator\`、\`upload-file\`、\`pdf-upload\`、\`process\`、\`CustomQuery\`、\`TableColumnDrawer\`、\`ExportExcel\`、\`CirculationForm\`
+  ${bt}microme-operator${bt}、${bt}upload-file${bt}、${bt}pdf-upload${bt}、${bt}process${bt}、${bt}CustomQuery${bt}、${bt}TableColumnDrawer${bt}、${bt}ExportExcel${bt}、${bt}CirculationForm${bt}
 
 ### 处理原则
 - 对被当前功能引用的相关业务功能，需说明其作用、触发方式、数据关系、交互关系
@@ -86,26 +88,26 @@ export function buildPromptMessages(featurePath) {
 ## 非业务目录过滤规则
 若指定路径属于以下目录，则跳过并说明原因：
 
-- \`error/\`
-- \`login/\`
-- \`demo/\`
-- \`i18n/\`
-- \`components/\`
+- ${bt}error/${bt}
+- ${bt}login/${bt}
+- ${bt}demo/${bt}
+- ${bt}i18n/${bt}
+- ${bt}components/${bt}
 
 ---
 
 ## 分析要求
 读取**指定功能目录及其直接引用的相关业务功能文件**，包括但不限于：
 
-- \`index.vue\`
-- \`form.vue\`
-- \`options.ts\`
-- 其他相关 \`ts\`、\`vue\`、\`js\` 文件
+- ${bt}index.vue${bt}
+- ${bt}form.vue${bt}
+- ${bt}options.ts${bt}
+- 其他相关 ${bt}ts${bt}、${bt}vue${bt}、${bt}js${bt} 文件
 
 重点分析：
 
 - API 接口调用
-- \`defineProps\` / \`defineEmits\`
+- ${bt}defineProps${bt} / ${bt}defineEmits${bt}
 - 计算逻辑
 - 字典引用
 - 组件引用
@@ -135,7 +137,7 @@ export function buildPromptMessages(featurePath) {
 ### 默认视为公共能力的情况
 - 状态值仅为通用枚举，如“编辑中、已完成、已提交”等
 - 状态变化仅表现为通用提交或流程驱动
-- 权限控制仅表现为 \`v-hasPermi\`、权限码、通用按钮显隐
+- 权限控制仅表现为 ${bt}v-hasPermi${bt}、权限码、通用按钮显隐
 - 按钮禁用条件仅表现为：
   - 选中 0 条 / 多条
   - 非创建人
@@ -155,11 +157,18 @@ export function buildPromptMessages(featurePath) {
 
 ---
 
+## 前置数据输出约束
+- “前置数据-数据来源”仅说明当前功能实际依赖的业务输入数据来源
+- 不写入通用状态类字段，如“单据状态”“流程状态”“审批状态”等
+- 若某状态字段仅用于通用流程控制、页面显隐或按钮控制，而不构成当前功能特有业务输入，则直接忽略
+
+---
+
 ## 必填校验说明过滤规则
 “必填校验”只说明**具有明确业务语义的特殊必填规则**，不说明纯表单层面的通用必填校验。
 
 ### 默认不写入文档的情况
-- 基础 \`required: true\`、普通必填校验
+- 基础 ${bt}required: true${bt}、普通必填校验
 - 页面全部字段的静态必填约束
 - 无业务条件、无联动、无特殊触发场景的必填项
 - 仅用于防止空值提交的通用表单校验
@@ -216,14 +225,27 @@ export function buildPromptMessages(featurePath) {
 
 ---
 
+## 核心业务逻辑输出约束
+- “核心业务逻辑”章节中，不写入表单字段分组、单据编号规则等框架通用内容
+- 仅保留体现当前功能特有业务语义的内容，如：
+  - 数据联动
+  - 业务计算
+  - 状态影响
+  - 条件判断
+  - 关键校验
+  - 业务动作逻辑
+- 若某内容仅属于表单渲染结构、页面布局组织、通用编码生成机制或框架层封装能力，则直接忽略，不进行说明
+
+---
+
 ## 输出规则
-- 输出到 \`开发规范/views/\` 目录下
+- 输出到 ${bt}开发规范/views/${bt} 目录下
 - 保持与源码相同的模块子目录结构
-- 文件命名规则：\`{功能目录名}-README.md\`
+- 文件命名规则：${bt}{功能目录名}-README.md${bt}
 
 示例：
-- 源码目录：\`src/views/pm/ba/PmBaRentcontractSettle/\`
-- 输出文件：\`开发规范/views/pm/ba/PmBaRentcontractSettle-README.md\`
+- 源码目录：${bt}src/views/pm/ba/PmBaRentcontractSettle/${bt}
+- 输出文件：${bt}开发规范/views/pm/ba/PmBaRentcontractSettle-README.md${bt}
 
 ### 关于被引用功能的输出规则
 - 若被引用功能仅作为当前功能一部分存在，则合并写入当前文档，不单独输出
@@ -248,7 +270,7 @@ export function buildPromptMessages(featurePath) {
 
 ## 额外要求
 - 若指定路径下存在多个页面文件或子场景文件，需一并分析并合并到同一份文档中
-- 若 \`index.vue\` 引入其他业务功能，必须说明：
+- 若 ${bt}index.vue${bt} 引入其他业务功能，必须说明：
   - 引入了什么功能
   - 在什么场景下触发
   - 与当前主功能的数据关系
@@ -261,17 +283,43 @@ export function buildPromptMessages(featurePath) {
 
 ---
 
+## 注意事项输出约束
+- “注意事项”章节中，不写入常规字段必填、框架通用内容限制、字段长度限制等通用校验或通用约束
+- 不写入纯前端层面的格式限制、输入长度限制、基础必填提示、通用提交流程限制
+- 不写入通用单据状态控制，例如“编辑中可编辑、非编辑中不可编辑/删除”这类通用规则
+- 不写入通用提交与流程机制，例如“直接提交后变已完成”“流程模式下进入审批流”这类项目级公共流程说明
+- 不写入通用按钮可用条件、创建人限制、状态限制、流程中限制等公共控制规则
+
+### 仅在以下情况才允许写入
+只有当相关内容体现当前功能特有业务语义时，才允许写入“注意事项”，例如：
+
+- 某状态限制并非项目通用规则，而是当前功能独有业务约束
+- 某提交限制会影响当前功能核心业务结果
+- 某流程分支由当前功能特有字段、业务类型、业务身份决定
+- 某操作限制对应明确的业务风险或业务后果
+
+### 保留内容范围
+“注意事项”仅保留与当前功能强相关的内容，例如：
+- 业务风险点
+- 使用边界
+- 特殊前置条件
+- 异常处理场景
+- 易错业务规则
+- 待确认事项
+
+---
+
 ## 输出前自检
 最终输出前，必须检查结果中是否包含以下关键词：
 
-- \`microme-operator\`
-- \`upload-file\`
-- \`pdf-upload\`
-- \`process\`
-- \`CustomQuery\`
-- \`TableColumnDrawer\`
-- \`ExportExcel\`
-- \`CirculationForm\`
+- ${bt}microme-operator${bt}
+- ${bt}upload-file${bt}
+- ${bt}pdf-upload${bt}
+- ${bt}process${bt}
+- ${bt}CustomQuery${bt}
+- ${bt}TableColumnDrawer${bt}
+- ${bt}ExportExcel${bt}
+- ${bt}CirculationForm${bt}
 
 如果包含，必须删除相关描述后再输出。
 **最终文档中，上述关键词出现次数必须为 0。**
@@ -281,10 +329,9 @@ export function buildPromptMessages(featurePath) {
 # 功能说明模板
 
 以下是功能说明文档的标准模板结构，请严格遵循：
-
-\`\`\`markdown
+${fence}markdown
 ${templateContent}
-\`\`\`
+${fence}
 `;
     return [
         {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mcp-feature-doc-generator",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "MCP server for generating Vue 3 feature documentation via prompt template",
   "type": "module",
   "main": "dist/index.js",