protools_document_suggest
Generate structured documentation from code or config changes by analyzing git diffs or file inputs. Extract implicit specifications, design decisions, or changelogs with customizable doc types and output formats.
Instructions
从代码/配置变更中提取隐含规范,生成结构化文档。
文档类型
spec: 技术规范(配置格式、字段定义、约束规则)
decision: 设计决策(为什么这么做、权衡考量)
changelog: 变更日志(按类别分组的变更记录)
auto: 自动推断最合适的类型
输出格式
markdown: 标准 Markdown
feishu: 飞书优化格式(默认,避免 HTML、标题不超 3 级)
使用示例
从 Git 变更生成技术规范:git_mode="staged", doc_type="spec"
从文件生成设计决策:inputs=["src/**/*.yml"], doc_type="decision"
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cwd | No | 工作目录,多仓库工作区时指定项目路径 | |
| format | No | 输出格式:markdown=标准 Markdown | feishu=飞书优化格式 | feishu |
| inputs | No | 要分析的文件/目录/glob 路径列表(与 git_mode 二选一) | |
| context | No | 附加的上下文说明,帮助 LLM 理解变更背景 | |
| doc_type | No | 文档类型:spec=技术规范 | decision=设计决策 | changelog=变更日志 | auto=自动推断 | auto |
| excludes | No | 排除的 glob 模式 | |
| git_mode | No | Git diff 模式:staged=已暂存 | unstaged=未暂存 | all=全部未提交 | |
| language | No | 输出语言:zh=中文 | en=英文 | zh |
| provider | No | LLM Provider,默认 gemini(格式化更好) | |
| extensions | No | 过滤扩展名,如 [".yml", ".yaml"] |