使用说明(简明、实用版)
-
项目简介
- 这是一个基于 MCP 协议的服务器端实现,面向“FOP工作流智能助手”场景,提供加载配置、执行工作流阶段、获取命名规则、智能检索配置等工具,供大语言模型客户端以统一的接口进行调用。
-
主要功能点
- 工具管理:列出并执行若干工具,如加载配置、获取工作流配置、显示配置摘要、获取智能检索配置、执行工作流阶段、获取文件命名规则等。
- 配置管理:加载并查询工作流及相关配置,支持查看摘要。
- 流程执行:按 stage1_prd_analysis、stage2_code_generation、stage3_flowchart_generation 三个阶段执行工作流,并返回执行结果信息。
- 文件命名规则:根据配置生成符合 FOP 规范的文件名。
- 安全与鲁棒性:内置错误处理与基本异常捕获,服务器以 Stdio 传输方式对接客户端。
-
安装步骤
- 需要的运行环境:Node.js 16.0 及以上。
- 使用一键安装(来自仓库提供的发布形态):
- 通过 MCP 客户端或 CLI 使用 npx 安装并启动服务: npx -y --registry=http://registry.m.jd.com @jd/fop-workflow-mcp-server
- 备注:该服务器设计为与 MCP 客户端通过 JSON-RPC 进行通信,客户端无需内部实现细节即可调用服务端提供的工具。
-
服务器配置(供 MCP 客户端启动时参考,实际使用时客户端不需要理解内部实现) 服务器名称(内置标识): joycode-mcp 启动命令示例(客户端需要提供的参数信息,非代码块文本,便于直接理解): { "mcpServers": { "fop-workflow-mcp-server": { "command": "npx", "args": ["-y", "--registry=http://registry.m.jd.com", "@jd/fop-workflow-mcp-server"], "disabled": false, "autoApprove": [] } } } 说明:
- 上述配置中的 alias 名为 fop-workflow-mcp-server,与仓库 README 提供的示例保持一致,实际服务器内置名称为 joycode-mcp。
- 该配置用于 MCP 客户端的启动示例,便于快速连通与测试。MCP 客户端本身只需要知道该服务器的启动命令与参数,不需要深入理解服务器内部实现。
-
基本使用方法
- 向 LLM 客户端发起请求,指派相应工具执行,如:
- 加载配置:load_config
- 获取工作流配置:get_workflow_config(可带 stage 参数)
- 显示配置摘要:show_config_summary
- 执行工作流阶段:execute_workflow_stage(需指定 stage 及输入数据 input_data)
- 获取文件命名规则:get_file_naming_rules
- 以上工具均通过 MCP 的 JSON-RPC 形式调用,服务器会返回结构化的输出内容,便于 LLM 将信息整合进对话或进一步处理。
- 向 LLM 客户端发起请求,指派相应工具执行,如:
-
额外说明
- 服务器默认通过标准输入输出(Stdio)传输,与常见本地开发/测试场景兼容。
- 如需进一步自定义,请参考仓库源码中对工具和输入输出格式的定义。
-
依赖与版本
- Node.js >= 16
- @modelcontextprotocol/sdk
- 服务器版本:JoyCode MCP服务器 v2.0.0(发布版)
信息
分类
AI与计算