Pega Dx MCP

🚀 Pega DX MCP Server

本項目藉助 Model Context Protocol，將 Pega Infinity™ 交互轉變為直觀的對話式體驗。通過連接 Pega DX API 與自然語言接口，它使 GenAI 代理、IDE 及其他支持 MCP 的工具能夠使用簡單、易讀的命令與 Pega Infinity™ 應用程序進行交互。

🚀 快速開始

前提條件

• Node.js (22+) 和 npm
• 可訪問啟用了 DX API 的 Pega Infinity™ (23+)
• OAuth 2.1 客戶端憑證

安裝

# 從 npm 安裝（推薦）
npm install -g @marco-looy/pega-dx-mcp

與 MCP 客戶端集成

該項目與 Claude Desktop、Claude Code、Cline 及許多其他支持 MCP 的應用程序兼容。將以下內容添加到 MCP 客戶端的配置文件中：

{
  "mcpServers": {
    "pega-dx-mcp": {
      "command": "npx",
      "args": ["-y", "@marco-looy/pega-dx-mcp"],
      "env": {
        "PEGA_BASE_URL": "https://your-pega-instance.com",
        "PEGA_CLIENT_ID": "your-client-id",
        "PEGA_CLIENT_SECRET": "your-client-secret"
      }
    }
  }
}

配置文件位置：

• Claude Desktop：請參閱 Claude Desktop 文檔，瞭解如何 添加 MCP 服務器
• Claude Code：請參閱 Claude Code 文檔，瞭解如何 配置 MCP 服務器
• Cline：請參閱 Cline 文檔，瞭解如何 編輯 Cline MCP 設置

提示：重啟 MCP 客戶端並確認 Pega DX MCP 工具可用。

✨ 主要特性

• 🤖 自然語言接口 - 演示對話式案例創建：“為 John 創建一個旅行索賠”
• 🔌 即插即用集成 - 與 GenAI 代理、IDE 和支持 MCP 的工具進行實驗性兼容
• 🧪 創新原型 - 探索具有全面錯誤處理方法的企業級模式
• 📡 API 集成探索 - 研究對案例、任務、附件和數據操作的訪問
• ⚡ 性能研究 - 試驗智能緩存和優化策略
• 🛡️ 安全框架 - 實現帶有 PKCE 的 OAuth 2.1 和基於角色的訪問控制模式

🧪 實驗性說明

Pega DX MCP Server 是一個探索模型上下文協議與 Pega Infinity™ 功能交集的實驗性項目。這不是 Pegasystems 的官方產品，也未普遍可用。所有命令、參數和其他功能可能隨時更改或棄用，無論是否提前通知。請勿將此 MCP 服務器用於生產功能。此實驗展示了自然語言接口在 Pega Infinity™ 交互中的潛力。我們歡迎反饋和貢獻，以幫助塑造由 GenAI 驅動的業務自動化的未來。

🏗️ 架構

Pega DX MCP Server 通過模型上下文協議將 GenAI 應用程序與 Pega Infinity 連接起來：

🛠️ 可用工具

Pega DX MCP Server 提供 60 多個綜合工具，分為 10 多個功能類別。每個類別可以通過 MCP 客戶端配置中的環境變量啟用或禁用，以實現精細控制。

🔧 工具配置

使用 MCP 客戶端配置中的環境變量控制加載哪些工具類別。默認情況下，所有類別均已啟用 - 將其設置為 "false" 可禁用：

示例 - 僅啟用核心案例管理工具：

{
  "mcpServers": {
    "pega-dx-mcp": {
      "command": "npx",
      "args": ["-y", "@marco-looy/pega-dx-mcp"],
      "env": {
        "PEGA_BASE_URL": "https://your-pega-instance.com",
        "PEGA_CLIENT_ID": "your-client-id",
        "PEGA_CLIENT_SECRET": "your-client-secret",
        "PEGA_SERVICE_TOOLS": "true",
        "PEGA_CASETYPE_TOOLS": "true",
        "PEGA_CASE_TOOLS": "true",
        "PEGA_ASSIGNMENT_TOOLS": "false",
        "PEGA_ATTACHMENT_TOOLS": "false",
        "PEGA_DATAVIEW_TOOLS": "false",
        "PEGA_DOCUMENT_TOOLS": "false",
        "PEGA_FOLLOWER_TOOLS": "false",
        "PEGA_PARTICIPANT_TOOLS": "false",
        "PEGA_RELATED_CASE_TOOLS": "false",
        "PEGA_TAG_TOOLS": "false"
      }
    }
  }
}

📋 完整工具清單

任務工具（9 個）

• get_assignment - 獲取詳細的任務信息
• get_assignment_action - 獲取任務操作詳細信息和 UI 元數據
• get_next_assignment - 獲取用戶的下一個工作任務
• jump_to_step - 導航到任務流程中的特定步驟
• navigate_assignment_previous - 導航到任務的上一步
• perform_assignment_action - 執行任務操作
• recalculate_assignment_fields - 重新計算任務表單字段
• refresh_assignment_action - 刷新任務操作表單數據
• save_assignment_action - 保存任務表單數據而不執行操作

附件工具（7 個）

• add_case_attachments - 將文件/URL 附加到案例
• delete_attachment - 從案例中移除附件
• get_attachment - 檢索附件內容
• get_attachment_categories - 列出可用的附件類別
• get_case_attachments - 列出所有案例附件
• update_attachment - 更新附件元數據
• upload_attachment - 上傳文件作為臨時附件

案例工具（16 個）

• add_optional_process - 添加階段或全案例可選流程
• bulk_cases_patch - 對多個案例執行操作
• change_to_next_stage - 將案例導航到下一階段
• change_to_stage - 將案例導航到特定階段
• create_case - 創建帶有內容的新案例
• delete_case - 刪除創建階段的案例
• get_case - 檢索詳細的案例信息
• get_case_action - 獲取案例操作詳細信息和元數據
• get_case_ancestors - 獲取案例祖先層次結構
• get_case_descendants - 獲取案例後代層次結構
• get_case_stages - 列出案例階段和流程
• get_case_view - 獲取特定案例視圖詳細信息
• get_case_view_calculated_fields - 計算案例視圖字段
• perform_bulk_action - 執行批量案例操作
• perform_case_action - 執行全案例操作
• recalculate_case_action_fields - 重新計算案例操作字段
• refresh_case_action - 刷新案例操作表單數據
• release_case_lock - 釋放悲觀案例鎖

案例類型工具（3 個）

• get_case_type_action - 獲取案例類型操作元數據
• get_case_type_bulk_action - 獲取案例類型的批量操作元數據
• get_case_types - 列出可用的案例類型

數據視圖工具（7 個）

• delete_data_record - 從可保存的數據頁面中刪除數據記錄
• get_data_objects - 列出可用的數據對象
• get_data_view_count - 獲取數據視圖結果計數
• get_data_view_metadata - 獲取數據視圖元數據和參數
• get_list_data_view - 使用過濾查詢列表數據視圖
• update_data_record_full - 完全更新數據記錄
• update_data_record_partial - 部分更新數據記錄

文檔工具（2 個）

• get_document - 以 base64 格式檢索文檔內容
• remove_case_document - 移除與案例關聯的文檔

關注者工具（3 個）

• add_case_followers - 將用戶添加為案例關注者
• delete_case_follower - 移除案例關注者
• get_case_followers - 列出案例關注者

參與者工具（7 個）

• create_case_participant - 向案例添加參與者
• delete_participant - 移除案例參與者
• get_case_participants - 列出所有案例參與者
• get_participant - 獲取特定參與者的詳細信息
• get_participant_role_details - 獲取參與者角色信息
• get_participant_roles - 列出可用的參與者角色
• update_participant - 更新參與者信息

相關案例工具（3 個）

• delete_related_case - 移除案例關係
• get_related_cases - 列出相關案例
• relate_cases - 創建案例關係

服務工具（1 個）

• ping_pega_service - 測試與 Pega Infinity 的 OAuth2 連接

標籤工具（3 個）

• add_case_tags - 向案例添加標籤
• delete_case_tag - 移除特定的案例標籤
• get_case_tags - 列出案例標籤

💻 使用示例

注意：以下示例展示了設想的功能和計劃的用戶體驗。這些場景代表了這個 GenAI 創新項目的實驗目標，可能不反映當前的實現狀態。

創建案例

用戶：“為保單 #12345 創建一個新的保險索賠”
AI：我將創建一個新的保險索賠案例。這是哪種類型的索賠？
用戶：“汽車事故索賠”
AI：✅ 已創建汽車事故索賠案例 INS-CLAIM-789
    案例 ID：INS-CLAIM-789
    保單：#12345
    狀態：已打開
    下一步：提供事故詳細信息

管理任務

用戶：“我的下一個任務是什麼？”
AI：你有 3 個待處理的任務：
    1. 審核索賠文件（INS-CLAIM-789） - 今天到期
    2. 批准旅行申請（TRAVEL-456） - 明天到期
    3. 客戶回電（SERVICE-123） - 2 小時後到期
用戶：“我要處理索賠審核”
AI：✅ 正在打開 INS-CLAIM-789 的索賠文件審核
    [顯示相關案例數據和所需操作]

⚙️ 配置

環境變量

# Pega Infinity 連接
PEGA_BASE_URL=https://your-pega-instance.com

# OAuth 2.1 認證
PEGA_CLIENT_ID=your-oauth-client-id
PEGA_CLIENT_SECRET=your-oauth-client-secret

OAuth 設置

1. 在你的 Pega Infinity 實例中 註冊 OAuth 客戶端
2. 配置 API 訪問範圍
3. 如果使用授權碼流程，則 設置重定向 URI
4. 使用客戶端憑證 更新環境變量

有關詳細的設置說明，請參閱我們的 配置指南。

🤝 貢獻

加入我們這個令人興奮的 GenAI 創新實驗！作為一個探索企業平臺自然語言接口未來的實驗性項目，我們歡迎社區參與塑造這個創新之旅。

貢獻方式

• 🔬 實驗反饋 - 分享你測試原型的經驗和見解
• 💡 創新想法 - 用創造性的建議為 GenAI 創新路線圖做出貢獻
• 🐛 問題報告 - 幫助識別這個實驗性項目中的挑戰
• 🔧 代碼貢獻 - 為代碼庫和概念驗證功能做出貢獻
• 📖 文檔編寫 - 幫助記錄學習成果和實驗結果
• 🧪 測試與驗證 - 參與測試新的實驗性功能

開發設置

# 分叉並克隆倉庫
git clone https://github.com/your-username/pega-dx-mcp.git
cd pega-dx-mcp

# 安裝依賴
npm install

# 創建功能分支
git checkout -b feature/your-feature-name

# 進行更改並測試
npm test

# 提交拉取請求

指南

• 遵循我們的 行為準則
• 確保測試通過，併為新功能添加新測試
• 為任何 API 更改更新文檔
• 使用常規的提交消息

📄 許可證

本項目採用 Apache 許可證 2.0 版。有關詳細信息，請參閱 LICENSE。