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 - 協議規範