Pega DX MCP

Pega DX MCP Server

为 Pega Infinity™ 应用启用对话式交互

此软件包通过 Model Context Protocol，将 Pega Infinity™ 交互转变为直观的对话式体验。它将 Pega DX API 与自然语言界面连接起来，使 GenAI Agent、IDE 和其他支持 MCP 的工具能够使用简单易读的命令与 Pega Infinity™ 应用交互。

🧪 实验性项目

Pega DX MCP Server 是一个实验性项目，旨在探索 Model Context Protocol 与 Pega Infinity™ 功能的交汇点。这不是 Pegasystems 的官方产品，也未正式推出。所有命令、参数和其他功能都可能随时更改或弃用，恕不另行通知。请勿将此 MCP 服务用于生产功能。此实验展示了自然语言界面与 Pega Infinity™ 交互的潜力。我们欢迎反馈和贡献，共同塑造由 GenAI 驱动的业务自动化的未来。

🌟 主要功能

• 🤖 自然语言界面 - 展示对话式创建案例：“为 John 创建一项旅行索赔”
• 🔌 即插即用集成 - 实验性支持 GenAI Agent、IDE 和支持 MCP 的工具
• 🧪 创新原型 - 探索企业级模式及全面的错误处理方法
• 📡 API 集成探索 - 调查对案例、任务、附件和数据操作的访问
• ⚡ 性能研究 - 尝试智能缓存和优化策略
• 🛡️ 安全框架 - 实现采用 PKCE 的 OAuth 2.1 和基于角色的访问控制模式

🚀 快速开始

前提条件

• Node.js（22+）和 npm
• 可访问启用了 DX API 的 Pega Infinity™（23+）
• OAuth 2.1 客户端凭据

安装

# Install from npm (recommended)
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 Server
• Claude Code：参阅 Claude Code 文档，了解如何配置 MCP Servers
• Cline：参阅 Cline 文档，了解如何编辑 Cline MCP 设置

**提示：**重启 MCP 客户端，并确认 Pega DX MCP 工具已可用。

🏗️ 架构

Pega DX MCP Server 使用 Model Context Protocol 将 GenAI 应用与 Pega Infinity 连接起来：

🛠️ 可用工具

Pega DX MCP Server 提供 60 多种综合工具，分为 10 多个功能类别。每个类别都可以通过环境变量启用或禁用，以便进行精细控制。

🔧 工具配置

在 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 Innovation 项目的实验目标，可能无法反映当前的实现状态。

创建案例

User: "Create a new insurance claim for policy #12345"
AI: I'll create a new insurance claim case. What type of claim is this?
User: "Auto accident claim"
AI: ✅ Created auto accident claim case INS-CLAIM-789
    Case ID: INS-CLAIM-789
    Policy: #12345
    Status: Open
    Next step: Provide accident details

管理分配

User: "What's my next assignment?"
AI: You have 3 pending assignments:
    1. Review claim documentation (INS-CLAIM-789) - Due today
    2. Approve travel request (TRAVEL-456) - Due tomorrow
    3. Customer callback (SERVICE-123) - Due in 2 hours
User: "Let me work on the claim review"
AI: ✅ Opening claim documentation review for INS-CLAIM-789
    [Displays relevant case data and required actions]

⚙️ 配置

环境变量

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

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

OAuth 设置

1. 注册 OAuth 客户端：在你的 Pega Infinity 实例中注册
2. 配置范围：设置 API 访问范围
3. 设置重定向 URI：如果使用授权码流程
4. 更新环境：填写客户端凭据

详细设置说明请参阅配置指南。

🤝 参与贡献

加入这项令人振奋的 GenAI Innovation 实验！作为一个探索企业平台自然语言界面未来的实验性项目，我们欢迎社区参与，共同塑造这段创新之旅。

参与方式

• 🔬 实验反馈 - 分享测试原型的体验和见解
• 💡 创新想法 - 通过富有创意的建议，为 GenAI Innovation 路线图贡献力量
• 🐛 问题报告 - 帮助发现此实验性项目中的挑战
• 🔧 代码贡献 - 为代码库和概念验证功能贡献代码
• 📖 文档编写 - 帮助记录经验和实验成果
• 🧪 测试与验证 - 参与测试新的实验性功能

开发环境设置

# Fork and clone the repository
git clone https://github.com/your-username/pega-dx-mcp.git
cd pega-dx-mcp

# Install dependencies
npm install

# Create a feature branch
git checkout -b feature/your-feature-name

# Make changes and test
npm test

# Submit pull request

指南

• 遵循我们的行为准则
• 确保测试通过，并为新功能添加测试
• 更新任何 API 变更对应的文档
• 使用约定式提交消息

📄 许可证

本项目采用 Apache License 2.0 许可。详情请参阅 LICENSE。