Skip to content

Commit 1d7d841

Browse files
author
wanghanxiong1
committed
feat(README): 更新README以反映新增功能和改进;增加代码生成增强流程、时序图输出、代码评审、用户可选规则配置和文件输出验证的说明;更新技术特性和文件结构说明;添加版本更新日志;增加输出文件说明表格;更新开发使用示例命令;增加依赖要求说明;更新许可证信息 ;
1 parent 6b1ec6e commit 1d7d841

File tree

8 files changed

+2017
-64
lines changed

8 files changed

+2017
-64
lines changed

README.md

Lines changed: 104 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# JoyCode MCP服务器 - FOP工作流智能助手
22

3-
基于标准MCP协议的专业工作流服务器,专注京东FOP平台需求分析、代码生成和流程图创建
3+
基于标准MCP协议的专业工作流服务器,专注京东FOP平台需求分析、代码生成、流程图创建和代码评审
44

55
## 🚀 一键安装
66

@@ -32,42 +32,116 @@ npx -y --registry=http://registry.m.jd.com @jd/fop-workflow-mcp-server
3232
- **"fop-workflow-mcp-server分析这个PRD"**
3333
- **"fop-workflow-mcp-server生成代码"**
3434
- **"fop-workflow-mcp-server创建流程图"**
35+
- **"fop-workflow-mcp-server评审代码"**
3536

3637
## 🔧 核心功能
3738

38-
### 1. 智能工作流执行
39-
- **stage1_prd_analysis**: PRD需求分析阶段
40-
- **stage2_code_generation**: 代码生成阶段
41-
- **stage3_flowchart_generation**: 流程图生成阶段
39+
### 1. 智能工作流执行(5个阶段)
40+
- **stage1_prd_analysis**: PRD需求分析阶段 - 深度分析需求文档
41+
- **stage2_code_generation**: 代码生成阶段 - 增强流程:代码分析→识别修改点→生成方案→实施修改
42+
- **stage3_flowchart_generation**: 流程图生成阶段 - 业务流程图、技术架构图、时序图
43+
- **stage4_code_review**: 代码评审阶段 - AI代码评审,检查质量、安全、性能
44+
- **stage5_final_verification**: 最终验证阶段 - 验证所有输出文件
4245

4346
### 2. 配置管理
4447
- **load_config**: 加载FOP配置文件
45-
- **get_workflow_config**: 获取工作流配置
48+
- **get_workflow_config**: 获取工作流配置(支持stage1-5)
4649
- **show_config_summary**: 显示配置摘要
4750

4851
### 3. 智能优化
4952
- **get_smart_retrieval_config**: 代码分析优化策略
5053
- **get_file_naming_rules**: FOP规范文件命名
5154
- **execute_workflow_stage**: 执行指定工作流阶段
5255

56+
### 4. 代码生成增强流程 🆕
57+
- **get_enhanced_code_workflow**: 获取增强的代码生成工作流
58+
- Step 1: 现有代码结构分析
59+
- Step 2: 梳理业务相关代码
60+
- Step 3: 识别需要修改的代码位置
61+
- Step 4: 生成代码修改方案
62+
- Step 5: 实施代码修改
63+
64+
### 5. 流程图/时序图输出 🆕
65+
- **get_flowchart_types**: 获取流程图类型配置
66+
- 业务流程图(businessFlow)
67+
- 技术架构图(technicalArchitecture)
68+
- 时序图(sequenceDiagram)
69+
- API调用链路图(apiCallChain)
70+
- 数据流向图(dataFlow)
71+
72+
### 6. 代码评审 🆕
73+
- **get_code_review_categories**: 获取代码评审类别
74+
- 代码质量检查
75+
- 安全检查
76+
- 性能检查
77+
- 异常处理检查
78+
- 业务逻辑检查
79+
- 架构规范检查
80+
81+
### 7. 用户可选规则 🆕
82+
- **get_user_selectable_rules**: 获取用户可选规则
83+
- **set_user_rules**: 设置用户自定义规则
84+
- minimal: 最小配置 - 只启用核心功能
85+
- standard: 标准配置 - 启用常用功能(推荐)
86+
- complete: 完整配置 - 启用所有功能
87+
- development: 开发调试配置
88+
89+
### 8. 文件输出验证 🆕
90+
- **verify_output_files**: 验证输出文件 - 检查所有必需文件是否正确生成
91+
- **get_output_directories**: 获取输出目录配置
92+
- **ensure_output_directories**: 确保输出目录存在
93+
5394
## 📊 技术特性
5495

5596
-**标准MCP协议**: 基于@modelcontextprotocol/sdk实现
5697
-**零配置安装**: 一键安装,无需额外设置
5798
-**稳定连接**: 内置心跳机制,不会超时
58-
-**完整工作流**: 保留原有FOP三阶段工作流
99+
-**完整工作流**: 5阶段工作流(PRD分析→代码生成→流程图生成→代码评审→最终验证)
59100
-**智能检索**: 减少70%无效代码检索,95%+准确率
101+
-**时序图输出**: 支持Mermaid时序图生成
102+
-**代码评审**: AI代码评审,检查质量、安全、性能
103+
-**用户可选规则**: 支持用户自定义规则配置
104+
-**文件验证**: 自动验证所有输出文件是否正确生成
60105

61106
## 📁 文件结构
62107
```
63108
├── index.js # MCP服务器主文件
64109
├── package.json # 发布配置
65110
├── fop/
66111
│ └── .joycode/
67-
│ └── fop-agent-config.json # 工作流配置
112+
│ ├── fop-agent-config.json # 主配置文件
113+
│ ├── config/
114+
│ │ └── user-rules-config.json # 用户规则配置
115+
│ ├── rules/
116+
│ │ ├── prd-analysis-rules.json # PRD分析规则
117+
│ │ ├── code-generation-rules.json # 代码生成规则
118+
│ │ ├── flowchart-generation-rules.json # 流程图生成规则
119+
│ │ ├── code-review-rules.json # 代码评审规则
120+
│ │ └── user-selectable-rules.json # 用户可选规则
121+
│ ├── generated-code/ # 生成的代码文件
122+
│ ├── flowcharts/ # 流程图文件
123+
│ ├── reports/ # 报告文件
124+
│ ├── plans/ # 方案文件
125+
│ ├── logs/ # 日志文件
126+
│ ├── implementation-summary/ # 实现总结
127+
│ └── analysis/ # 分析文档
68128
└── README.md # 使用说明
69129
```
70130

131+
## 📋 输出文件说明
132+
133+
### 必需输出文件
134+
| 阶段 | 文件类型 | 命名规则 | 说明 |
135+
|------|----------|----------|------|
136+
| Stage 1 | PRD分析 | {需求名称}-prd-analysis-summary.md | PRD分析文档 |
137+
| Stage 2 | 代码文件 | {需求名称}-{模块}-{时间戳}.java | 生成的代码 |
138+
| Stage 2 | 修改方案 | {需求名称}-code-modification-plan-{时间戳}.md | 代码修改方案 |
139+
| Stage 3 | 业务流程图 | {需求名称}-business-flow-{时间戳}.md | 业务流程图 |
140+
| Stage 3 | 技术架构图 | {需求名称}-technical-architecture-{时间戳}.md | 技术架构图 |
141+
| Stage 3 | 时序图 | {需求名称}-sequence-diagram-{时间戳}.md | 系统调用时序图 |
142+
| Stage 4 | 评审报告 | {需求名称}-code-review-report-{时间戳}.md | 代码评审报告 |
143+
| Stage 5 | 验证报告 | {需求名称}-output-verification-report-{时间戳}.md | 输出验证报告 |
144+
71145
## 🛠️ 开发使用
72146

73147
```bash
@@ -79,13 +153,35 @@ npm run config
79153

80154
# 获取工作流配置
81155
npm run stage -- --stage stage1_prd_analysis
156+
157+
# 获取增强代码工作流
158+
npm run workflow -- --step step1_existingCodeAnalysis
159+
160+
# 验证输出文件
161+
npm run verify -- --requirement_name "库存管理优化"
82162
```
83163

84164
## 📋 依赖要求
85165

86166
- Node.js >= 16.0.0
87167
- @modelcontextprotocol/sdk ^1.25.0
88168

169+
## 🔄 版本更新
170+
171+
### v4.0.0 (2025-09-10)
172+
- 🆕 新增代码生成增强流程(5步工作流)
173+
- 🆕 新增时序图输出功能
174+
- 🆕 新增代码评审功能
175+
- 🆕 新增用户可选规则配置
176+
- 🆕 新增文件输出验证机制
177+
- 🔧 优化工作流阶段(5个阶段)
178+
- 🔧 增强配置文件结构
179+
180+
### v3.0.0
181+
- 初始版本
182+
- 支持3阶段工作流
183+
- 基础PRD分析、代码生成、流程图功能
184+
89185
## 📄 许可证
90186

91187
MIT License
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"preset": "standard",
3+
"description": "用户规则配置 - 标准配置",
4+
"lastUpdated": "2025-09-10",
5+
"enabledRules": {
6+
"prdAnalysis": {
7+
"templateContentFilter": true,
8+
"navigationOptimization": true,
9+
"fopSpecificAnalysis": true,
10+
"speedOptimization": true
11+
},
12+
"codeGeneration": {
13+
"intelligentRetrieval": true,
14+
"existingCodeAnalysis": true,
15+
"businessCodeIdentification": true,
16+
"modificationPointIdentification": true,
17+
"codeModificationPlan": true,
18+
"codeStandards": true,
19+
"qualityAssurance": true
20+
},
21+
"flowchartGeneration": {
22+
"businessFlowchart": true,
23+
"technicalArchitecture": true,
24+
"sequenceDiagram": true,
25+
"apiCallChain": true,
26+
"dataFlowDiagram": false
27+
},
28+
"codeReview": {
29+
"codeQuality": true,
30+
"securityCheck": true,
31+
"performanceCheck": true,
32+
"exceptionHandling": true,
33+
"businessLogic": true,
34+
"architectureCompliance": true
35+
},
36+
"outputVerification": {
37+
"fileExistenceCheck": true,
38+
"contentCompletenessCheck": true,
39+
"formatComplianceCheck": true,
40+
"dependencyCheck": true,
41+
"generateVerificationReport": true
42+
}
43+
}
44+
}

0 commit comments

Comments
 (0)