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。