@guru-ai-product/ai-product-kit 0.2.251112184032 → 0.2.251113163244

package/mcp/.doc_cache/ec9ad6ce24808f0a_/351/234/200/346/261/202/345/217/230/345/212/250/350/257/264/346/230/216/347/224/237/346/210/220Prompt.md

@@ -0,0 +1,349 @@
+# 需求变动说明生成Prompt
+
+## 基础Prompt
+
+```
+请看下当前<版本目录>的需求和<commit-hash>这个commit的差异，并形成一个变动说明文档。
+
+要求：
+1. 对比这两个commit之间的所有文件变化（不仅仅是这个commit涉及的文件，而是这个commit之后的所有文件的状态）
+2. 详细说明每个文档的新增、修改、删除内容
+3. 所有的修改说明希望能链接到具体的位置（文件名和行号）
+4. 在第3、4节中具体说明都做了哪些变动、新增、去除，便于跟踪变化
+5. 使用📄表示文件链接，📍表示位置链接
+6. 生成统计表格汇总变动情况
+7. 章节序号要连续正确
+8. 在标题上增加对比的两段日期的说明
+
+文档结构要求：
+- 第1节：变动概述
+- 第2节：Commit历史
+- 第3节：文档级变动详情（详细说明新增、修改、删除内容及具体位置）
+- 第4节：功能维度变动分析（从功能角度分析变动）
+- 第5节：产品策略分析
+- 第6节：附录（统计表、命令等）
+
+不要包含：
+- 开发影响评估章节
+- 待确认事项章节
+- 建议后续行动章节
+```
+
+## 增强Prompt（包含更多细节）
+
+```
+我需要生成一份需求文档变动说明，对比<旧commit>和<新commit>（或HEAD）之间的变化。
+
+### 分析要求：
+
+1. **识别所有变更文件**
+   - 使用 git diff --stat 和 git diff --name-status 识别变更的文件
+   - 区分修改(M)、新增(A)、删除(D)的文件
+   - 分版本目录（如v2.0.0、v2.1.0）组织
+
+2. **详细分析每个文件**
+   - 对于修改的文件：
+     * 使用 git diff 查看具体变更
+     * 使用 grep "^## |^### " 获取章节结构
+     * 使用 grep -n 定位关键内容的行号
+     * 详细列出新增的章节、功能点（附带行号链接）
+     * 详细列出修改的内容（附带行号链接）
+     * 说明删除的内容
+   
+   - 对于新增的文件：
+     * 获取文档的章节结构
+     * 列出主要章节并链接到具体行号
+     * 标注文档规模（总行数）
+     * 说明文档的功能类型
+
+3. **生成文档结构**
+
+**第1节 - 变动概述**：
+- 标题下方用引用块显示：变动周期（起止日期）、对比版本（commit号）
+- 对比版本信息（commit号、日期、提交信息）
+- 总体统计（文件数、行数变化）
+
+**第2节 - Commit历史**：
+- 列出期间所有commit
+- 每个commit包含：hash、日期、提交信息、变更文件概要
+
+**第3节 - 文档级变动详情**：
+按版本目录组织，对每个文档：
+- 添加📄文件链接
+- 标注变动量（+/-行数）
+- **新增内容**：列表形式，重要项用📍链接到具体行号
+- **修改内容**：列表形式，重要项用📍链接到具体行号
+- **删除内容**：说明删除的内容
+
+**第4节 - 功能维度变动分析**：
+- 4.1 核心新功能：列出新增的重要功能，每个功能包含：
+  * 📄文档链接
+  * 功能定位
+  * 新增内容（各功能模块用📍链接）
+  * 技术要求（用📍链接）
+  * 开发复杂度预估
+  
+- 4.2 核心功能优化：列出优化的功能，包含：
+  * 📄文档链接
+  * 新增部分（用📍链接）
+  * 修改部分（用📍链接）
+  * 删除部分
+  * 开发影响预估
+
+**第5节 - 产品策略分析**：
+- 功能战略定位（创作能力、用户增长、商业化）
+- 版本演进路径
+
+**第6节 - 附录**：
+- 完整变更文件清单
+- 变动统计汇总表（markdown表格）
+- Commit详情
+- Git命令
+- 文档结构树状图
+
+### 格式要求：
+
+1. **链接格式**：
+   - 文件链接：`📄 查看文件 (./文件名.md)` 或 `📄 查看完整文档 (../vX.X.X/文件名.md)`
+   - 行号链接：`📍 说明文字 → \`章节名称:行号\` (./文件名.md#L行号)`
+
+2. **图标使用**：
+   - 📄 文件链接
+   - 📍 位置链接
+   - ⭐⭐⭐ / ⭐⭐ / ⭐ 重要程度
+
+3. **表格格式**：
+   ```markdown
+   | 类型 | 数量 | 行数 |
+   |------|------|------|
+   | 修改文档 | X个 | +XXX/-XX |
+   ```
+
+4. **章节序号**：确保连续，无跳跃
+
+5. **引用块**：标题下方的关键信息用 `>` 引用
+
+### 输出文档
+
+文档命名：`YYYYMMDD_需求文档变动说明_<旧commit>至<新commit>.md`
+保存位置：`../../vX.X.X/`
+
+请开始分析并生成变动说明文档。
+
+```
+
+## 分步执行Prompt（适合复杂场景）
+
+### Step 1: 收集变更信息
+
+```
+
+第一步：收集变更信息
+
+请执行以下命令并记录结果：
+
+1. 查看变更文件列表：
+   git diff --name-status <旧commit>..<新commit> -- "../../requirements"
+
+2. 查看变更统计：
+   git diff --stat <旧commit>..<新commit> -- "../../requirements"
+
+3. 查看commit历史：
+   git log --oneline <旧commit>..<新commit>
+
+4. 对每个commit查看详情：
+   git show --stat <commit-hash>
+
+请整理并告诉我：
+
+- 有哪些文件被修改了？（M）
+- 有哪些文件是新增的？（A）
+- 有哪些文件被删除了？（D）
+- 每个文件的行数变化
+- 涉及的commit数量和信息
+
+```
+
+### Step 2: 分析修改的文档
+
+```
+
+第二步：分析修改的文档
+
+对于每个被修改的文档（标记为M），请：
+
+1. 查看文档的章节结构：
+   grep -n "^## |^### |^#### " 文档路径
+
+2. 查看具体变更：
+   git diff <旧commit>..<新commit> -- "文档路径"
+
+3. 对每个文档生成变动说明，包括：
+   - 📄 文件链接
+   - 变动量（+X行/-Y行）
+   - **新增内容**：
+     - 新增的章节（章节名 + 行号链接）
+     - 新增的功能点（描述 + 行号链接）
+   - **修改内容**：
+     - 修改的章节（章节名 + 行号链接）
+     - 修改的内容描述
+   - **删除内容**：
+     - 删除的内容说明
+
+请分析：<文档名>
+
+```
+
+### Step 3: 分析新增的文档
+
+```
+
+第三步：分析新增的文档
+
+对于每个新增的文档（标记为A），请：
+
+1. 查看文档章节结构：
+   grep -n "^## |^### |^#### " 文档路径
+
+2. 查看文档行数：
+   wc -l 文档路径
+
+3. 生成文档说明，包括：
+   - 📄 文件链接
+   - 文档规模（总行数）
+   - **包含内容**（主要章节，每个章节链接到行号）：
+     - 📍 章节1 → [`章节名称:行号`](路径#L行号)
+     - 📍 章节2 → [`章节名称:行号`](路径#L行号)
+   - 功能类型说明
+
+请分析：<文档名>
+
+```
+
+### Step 4: 生成完整文档
+
+```
+
+第四步：生成完整的变动说明文档
+
+基于前面收集的信息，生成完整文档，结构如下：
+
+# [版本] 需求文档变动说明
+
+> **变动周期**: <起始日期> → <结束日期>（X天）  
+> **对比版本**: `<旧commit>` → `<新commit>`
+
+## 1. 变动概述
+
+[填入：版本信息、统计数据]
+
+## 2. Commit 历史
+
+[填入：每个commit的信息]
+
+## 3. 文档级变动详情
+
+[填入：每个文档的详细变动]
+
+## 4. 功能维度变动分析
+
+[填入：功能级别的分析]
+
+## 5. 产品策略分析
+
+[填入：战略层面的分析]
+
+## 6. 附录
+
+[填入：统计表、命令等]
+
+请生成完整文档。
+
+```
+
+## 质量检查Prompt
+
+```
+
+请检查刚生成的变动说明文档，确认：
+
+1. **链接有效性**：
+   - [ ] 所有📄文件链接路径正确
+   - [ ] 所有📍行号链接格式正确（使用#L前缀）
+   - [ ] 相对路径使用正确（./同级，../上级）
+
+2. **内容完整性**：
+   - [ ] 所有修改的文档都有新增、修改、删除说明
+   - [ ] 重要功能点都有行号链接
+   - [ ] 统计数据准确（文件数、行数）
+   - [ ] Commit信息完整
+
+3. **格式规范**：
+   - [ ] 章节序号连续（1,2,3,4,5,6）
+   - [ ] 图标使用正确（📄📍⭐）
+   - [ ] 表格格式正确
+   - [ ] 代码块正确标记
+
+4. **可读性**：
+   - [ ] 结构清晰
+   - [ ] 描述准确
+   - [ ] 重点突出
+
+请指出发现的问题并修正。
+
+```
+
+## 使用示例
+
+### 示例1：基础使用
+
+```
+
+请看下当前v2.0.0的需求和90cad63faefa9edd7957c256493ae144bd4de5b5这个commit的差异，
+并形成一个变动说明文档。
+
+要求按照标准格式，包含详细的变动说明和具体位置链接。
+
+```
+
+### 示例2：多版本对比
+
+```
+
+请对比../../目录下v2.0.0和v2.1.0两个版本，
+在commit 90cad63 到 HEAD 之间的所有变化，生成变动说明文档。
+
+需要：
+
+1. 分别说明两个版本的变化
+2. v2.1.0是新增的版本目录，需要特别标注
+3. 所有重要变动都要有具体位置链接
+
+```
+
+### 示例3：重点功能分析
+
+```
+
+生成需求变动说明，重点分析以下功能的变化：
+
+1. Draw to Video功能（新增）
+2. 积分签到系统（新增）
+3. 多模式视频生成平台（大幅更新）
+4. 付费方案优化（新增）
+
+对每个功能详细说明：
+
+- 功能模块及具体位置
+- 技术实现要求及位置
+- 开发工作量预估
+
+```
+
+## 注意事项
+
+1. **确保git仓库状态**：在分析前确认本地仓库是最新的
+2. **行号可能变化**：如果文档被修改，行号可能不准确，需要重新确认
+3. **相对路径**：注意文档之间的相对路径关系
+4. **图片文件**：图片文件标注类型和用途，不需要行号
+5. **draft文件**：draft文件简要说明即可，不需要详细分析

package/mcp/README.md

@@ -0,0 +1,90 @@
+# MCP 本地服务集成指南
+
+本目录为 AI Product Kit 的本地 MCP（Model Context Protocol）服务实现，支持 agent 通过 MCP 协议访问文档、工具等资源。
+
+## 1. 安装依赖
+
+使用 Node 安装：
+
+```bash
+cd mcp && npm install
+```
+
+## 2. MCP 服务对接方式
+
+本 MCP 服务采用 **stdio 方式**与 Agent 通信，不支持 HTTP 访问模式。
+
+### 2.1 Agent 侧对接（主要使用场景）
+
+Agent 通过 stdio 方式与 MCP 服务通信，这是主要的使用场景：
+
+- Agent 通过 MCP 协议调用工具（tool）、获取文档（resource）、获取 prompt 模板等
+- 支持 structured output，便于 agent 解析结构化结果
+- 可参考 [MCP 官方文档](https://modelcontextprotocol.io) 获取标准协议、客户端调用示例
+
+#### Agent 工具 rule 配置
+
+为了确保 Agent 工具（如 Cursor、Kilo Code 等）能够自动使用 Product-Kit MCP 服务，请在相应的 Agent 工具中增加以下 rule：
+
+**rule 内容：**
+
+```
+在生成或编辑文档时，根据实际情况优先使用 {MCP_SERVER_NAME} 来获取合适的模板和工具支持。
+```
+
+> **注意**：请将 `{MCP_SERVER_NAME}` 替换为实际的 MCP 服务名称（如 Product-Kit、AI Product Kit 等）。
+
+这个 rule 将指导 Agent 在文档生成和编辑任务中主动调用相应的 MCP 服务，获取相关的模板和工具支持，从而提升文档质量和一致性。
+
+#### stdio 方式配置示例
+
+假如你的 agent 支持通过配置文件调用本地 MCP 服务，可参考如下配置：
+
+**JSON 示例：**
+
+```json
+{
+  "mcp_server": {
+    "command": "node",
+    "args": [
+      "/absolute/path/to/mcp/src/server.js"
+    ]
+  }
+}
+```
+
+- `command`：启动命令（使用 node）
+- `args`：填写 `mcp/src/server.js` 的绝对路径
+- `env`：如需自定义环境变量可在此设置
+
+> **注意**：请将示例中的路径替换为你本地实际的项目根目录绝对路径。
+
+### 2.2 本地调试启动（辅助使用场景）
+
+仅在需要本地调试 MCP 服务时，可以手动启动服务：
+
+```bash
+cd mcp/src && node server.js
+```
+
+成功启动后会显示 “Loaded X skills” 等日志。
+
+## 3. 常见开发与测试
+
+- 生成与同步：
+  - 当新增/删除 Skill 时，运行：
+    ```bash
+    node tools/build_package update-mcp
+    ```
+    该命令会重建 `mcp/src/server.js` 并刷新文档中的 MCP 调用表。
+
+- 本地验证：
+  - 在 `mcp/src` 直接运行 `node server.js`，验证加载与工具列表无误。
+  - 无需单独测试框架。
+
+## 4. 参考文档
+
+- [MCP 官方文档](https://modelcontextprotocol.io)
+- 附：Python 版 SDK 知识文档保留在 `knowledge/` 仅作背景参考（服务实现已使用 Node）。
+
+如有 agent 侧集成问题，可参考上述文档或联系开发者。

package/mcp/docs/AI_Product_Kit_MCP_/351/234/200/346/261/202/350/257/264/346/230/216.md

@@ -0,0 +1,93 @@
+# AI Product Kit MCP 需求说明
+
+## 背景
+
+为提升 AI Product Kit 项目的智能化和自动化水平，需要构建一个基于 Model Context Protocol (MCP) 的服务，帮助用户便捷地获取和使用项目内的各类文档指南和模板。
+
+## 目标
+
+- 用户可通过 Agent 请求，自动获取 /docs 目录下各类文档的编写指南和模板文件地址。
+- 支持常见文档类型（如需求文档、设计文档、测试文档等）和工具类操作（如文档更新标记、Prompt 生成、drawio 文档生成等）。
+- 降低用户查找和使用文档模板的门槛，提高文档编写效率和规范性。
+
+## 核心功能
+
+1. **获取文档指南地址**
+   - 输入：文档类别（枚举字符串）
+   - 输出：对应文档指南的本地缓存文件地址（如 Markdown 文件路径）
+   - 说明：如有对应指南，返回缓存文件地址；如无，返回支持的文档类别列表。
+
+   **支持的文档类别及使用场景**：
+   - "需求文档": 统一指南，包含需求文档模板和需求迭代模板的选择和执行流程。
+             需求文档模板：适用于项目从0到1的完整需求规划，或重大版本调整（如v1.0到v2.0）
+                         包含完整的产品定位、功能需求、商业化策略、UI/UX设计等四个模块
+                         适用于：新产品开发、重大功能重构、跨团队大型项目
+             需求迭代模板：适用于现有产品的功能优化、bug修复、小功能迭代
+                         包含需求背景、整体修改逻辑、客户端/服务端实现等
+                         适用于：功能优化、性能提升、用户体验改进、小功能添加
+             注意：Agent会先进行模板选择确认，等待用户确认后再执行对应的流程
+
+   - "立项规划文档": 适用于项目立项前的商业分析和技术规划
+                   包含SWOT分析、市场分析、技术可行性评估等
+
+   - "技术架构设计文档": 适用于系统架构设计和技术方案制定
+                       包含数据库设计、API设计、前后端架构等
+
+2. **获取工具模板地址**
+   - 输入：工具名称（枚举字符串）
+   - 输出：对应工具模板的本地缓存文件地址
+
+   **支持的工具名称及使用场景**：
+   - "Prompt生成": 用于生成高质量的AI Prompt，指导AI模型生成新的Prompt
+               适用于：需要创建AI提示词、优化现有Prompt、标准化Prompt格式
+               特点：确保Prompt结构清晰、语言简洁、可操作性强
+
+   - "标记文档更新": 用于自动标记文档中更新过的内容，便于阅读者识别变更
+                  适用于：文档版本管理、团队协作、变更追踪
+                  特点：使用颜色标记修改和新增内容，支持git检查未提交更新
+
+   - "生成DrawIO文档": 用于将需求或图片描述转化为DrawIO图表代码
+                    适用于：系统架构图、流程图、组织结构图等各类图表制作
+                    特点：生成可运行的draw.io代码，支持自动布局优化和语法校验
+
+   - "AI体验设计指南": 用于指导AI功能的交互设计，确保符合AI体验感标准
+                    适用于：AI功能设计、用户体验优化、交互流程设计
+                    特点：基于最小化输入、透明化输出、迭代式改进三大原则
+
+## 本地改写缓存方案
+
+- MCP 服务在首次接收到文档请求时，会读取源文档，将其中所有本地/相对引用地址递归改写为可访问的本地绝对路径或统一的本地缓存路径。
+- 改写后的文档会被临时保存到本地缓存目录，并记录源文档的最后修改时间。
+- 下次请求该文档时，若源文档的最后修改时间未变，则直接返回缓存的改写文档；若已变，则重新改写并更新缓存。
+- 在改写文档引用地址时，会递归处理所有被引用的本地文件，确保所有层级的引用都被正确替换。
+- 需避免循环引用和死循环。
+- 可扩展缓存清理策略（如定期清理过期缓存）。
+
+## 典型使用场景
+
+### 需求文档场景
+
+- 用户请求"请帮我生成一个新产品 XX 的完整需求文档"，Agent 通过 MCP 获取"需求文档"指南，首先进行模板选择确认，推荐使用"需求文档模板"，等待用户确认后执行完整的需求文档生成流程，包含产品定位、功能需求、商业化策略、UI/UX设计的完整文档。
+- 用户请求"帮我规划一个重大版本升级的需求"，Agent 通过 MCP 获取"需求文档"指南，进行模板选择确认，推荐使用"需求文档模板"，用于重大版本调整的完整需求规划。
+- 用户请求"帮我优化现有产品的某个功能"，Agent 通过 MCP 获取"需求文档"指南，进行模板选择确认，推荐使用"需求迭代模板"，等待用户确认后执行需求迭代流程。
+- 用户请求"帮我修复产品中的某个bug并添加相关功能"，Agent 通过 MCP 获取"需求文档"指南，进行模板选择确认，推荐使用"需求迭代模板"，等待用户确认后执行需求迭代流程。
+
+### 工具使用场景
+
+- 用户请求"帮我生成一个高质量的AI Prompt"，Agent 通过 MCP 获取"Prompt生成"模板，指导用户创建结构清晰、可操作性强的AI提示词。
+- 用户请求"帮我标记文档中更新过的内容"，Agent 通过 MCP 获取"标记文档更新"模板，自动标记文档的修改和新增内容，便于团队协作和变更追踪。
+- 用户请求"帮我生成系统架构图"，Agent 通过 MCP 获取"生成DrawIO文档"模板，将用户需求转化为可运行的DrawIO图表代码。
+- 用户请求"帮我设计AI功能的交互体验"，Agent 通过 MCP 获取"AI体验设计指南"模板，生成符合AI体验感标准的交互设计指导。
+
+## 目录结构参考
+
+- [`skills/aipk_requirements/documentation/SKILL.md`](../../skills/aipk_requirements/documentation/SKILL.md)
+- [`skills/aipk_tool_prompts/Prompt生成.md`](../../skills/aipk_tool_prompts/Prompt生成.md)
+- [`skills/aipk_tool_prompts/标记文档更新.md`](../../skills/aipk_tool_prompts/标记文档更新.md)
+- [`skills/aipk_tool_prompts/生成DrawIO文档.md`](../../skills/aipk_tool_prompts/生成DrawIO文档.md)
+
+## 备注
+
+- MCP 服务需支持后续扩展，便于增加新的文档类型和工具模板。
+- 返回的文件地址为本地缓存文件路径，Agent 可直接读取和引用。
+- 可根据实际需求扩展为HTTP服务，支持远程访问和跳转。