Bpmn MCP

🚀 BPMN-MCP

BPMN-MCP 是一个模型上下文协议（MCP）服务器，用于以编程方式创建和操作 BPMN 2.0 工作流图。该服务器使 AI 助手和其他工具能够以标准 BPMN 格式生成、编辑和导出业务流程图。

✨ 主要特性

• 创建 BPMN 图：从头开始生成新的工作流图。
• 添加流程元素：插入事件、任务、网关和子流程。
• 连接元素：在工作流组件之间创建顺序流。
• 导出格式：将图保存为 BPMN 2.0 XML 或 SVG 格式。
• 导入支持：加载和修改现有的 BPMN XML 文件。
• 智能提示：获得有用的提示，确保工作流完整且连接正确。

📦 安装指南

前提条件

• Node.js（v16 或更高版本）
• npm 或 yarn

本地设置

1. 克隆仓库：

git clone https://github.com/dattmavis/BPMN-MCP.git
cd BPMN-MCP

2. 安装依赖项：

npm install

3. 构建项目：

npm run build

📚 详细文档

针对 Claude Desktop 的配置

将以下内容添加到您的 Claude Desktop 配置文件中：

• macOS：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "bpmn": {
      "command": "node",
      "args": ["/absolute/path/to/BPMN-MCP/dist/index.js"]
    }
  }
}

将 /absolute/path/to/BPMN-MCP 替换为您克隆此仓库的实际路径。

针对其他 AI 工具的配置

此 MCP 服务器可与任何支持模型上下文协议的工具配合使用。配置其运行命令如下：

node /path/to/BPMN-MCP/dist/index.js

💻 使用示例

配置完成后，您可以要求您的 AI 助手创建 BPMN 图。以下是一些示例请求：

创建简单工作流

创建一个订单处理工作流的 BPMN 图，包含以下步骤：
1. 订单已接收（开始事件）
2. 验证订单（用户任务）
3. 处理付款（服务任务）
4. 订单完成（结束事件）

用顺序流将它们连接起来。

创建带有决策点的工作流

创建一个客户支持票务路由的 BPMN 图：
- 开始：票务已接收
- 任务：对票务进行分类
- 网关：检查优先级
  - 如果是高优先级：升级到高级支持团队
  - 如果是正常优先级：分配给支持团队
- 两条路径都通向：票务已解决（结束）

📚 详细文档

可用工具

MCP 服务器提供以下工具：

• create_bpmn_diagram：创建一个新的 BPMN 图并返回图的 ID。
• add_bpmn_element：向图中添加一个元素。支持的类型包括：
  • 事件：bpmn:StartEvent、bpmn:EndEvent、bpmn:IntermediateCatchEvent、bpmn:IntermediateThrowEvent
  • 任务：bpmn:Task、bpmn:UserTask、bpmn:ServiceTask、bpmn:ScriptTask、bpmn:ManualTask、bpmn:BusinessRuleTask、bpmn:SendTask、bpmn:ReceiveTask
  • 网关：bpmn:ExclusiveGateway、bpmn:ParallelGateway、bpmn:InclusiveGateway、bpmn:EventBasedGateway
  • 其他：bpmn:SubProcess
• connect_bpmn_elements：在两个元素之间创建顺序流。
• export_bpmn_xml：将图以 BPMN 2.0 XML 格式导出。
• export_bpmn_svg：将图以 SVG 格式导出以便可视化。
• list_bpmn_elements：列出图中的所有元素。
• import_bpmn_xml：导入现有的 BPMN XML 文件进行编辑。

示例输出

服务器生成的标准 BPMN 2.0 XML 文件可在以下工具中打开：

• Camunda Modeler
• bpmn.io
• 任何符合 BPMN 2.0 标准的工具

示例 XML 输出：

<?xml version="1.0" encoding="UTF-8"?>
<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL"
                   xmlns:bpmndi="http://www.omg.org/spec/BPMN/20100524/DI"
                   xmlns:dc="http://www.omg.org/spec/DD/20100524/DC"
                   xmlns:di="http://www.omg.org/spec/DD/20100524/DI">
  <bpmn:process id="Process_1" isExecutable="true">
    <bpmn:startEvent id="Event_1" name="Start">
      <bpmn:outgoing>Flow_1</bpmn:outgoing>
    </bpmn:startEvent>
    <bpmn:task id="Task_1" name="Process">
      <bpmn:incoming>Flow_1</bpmn:incoming>
      <bpmn:outgoing>Flow_2</bpmn:outgoing>
    </bpmn:task>
    <bpmn:endEvent id="Event_2" name="End">
      <bpmn:incoming>Flow_2</bpmn:incoming>
    </bpmn:endEvent>
    <bpmn:sequenceFlow id="Flow_1" sourceRef="Event_1" targetRef="Task_1" />
    <bpmn:sequenceFlow id="Flow_2" sourceRef="Task_1" targetRef="Event_2" />
  </bpmn:process>
  <!-- 为简洁起见，省略了图信息 -->
</bpmn:definitions>

🚀 快速开始

开发模式运行

npm run watch

这将在源文件更改时自动重新构建项目。

测试

您可以使用 MCP 协议手动测试服务器：

node dist/index.js

然后通过标准输入发送 JSON-RPC 请求。示例：

{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}

🔧 技术细节

架构

• 运行时：使用 TypeScript 的 Node.js
• BPMN 引擎：bpmn-js（使用 jsdom 的无头模式）
• 协议：模型上下文协议（MCP）
• 输出：BPMN 2.0 XML 标准

智能工作流提示

服务器包含有用的提示，以确保图的完整性：

• 在添加任务/事件时提醒您连接元素。
• 在导出包含未连接元素的图时发出警告。
• 建议使用 connect_bpmn_elements 创建正确的工作流。

📄 许可证

本项目采用 MIT 许可证。

🤝 贡献

欢迎贡献代码！请随时提交问题或拉取请求。

🛠️ 支持

如果您遇到问题或有疑问：

• 在 GitHub 上创建一个问题。
• 查看现有问题以寻找解决方案。

📚 相关项目

• bpmn-js - BPMN 2.0 渲染工具包
• Model Context Protocol - 协议规范