Pega DX API V1 MCP服务器
MCP(模型上下文协议)服务器 Pega传统DX API V1 (/prweb/api/v1/).
专为基于Pega的应用程序而设计 基于部分的用户界面 (UI工具包/主题宇宙/Pega 8.3-8.6)。对于基于Constellation的应用程序,请使用 V2 MCP 相反。
______________________________________________________________________
工具(共135件)
服务(1)
| 工具 | 说明 |
|---|
ping_pega_service | 测试连接并验证身份验证 |
案例(9)
| 工具 | 端点 | 描述 |
|---|
get_cases | GET /cases | 列出所有用户案例(最多500个,V1除外) |
create_case | POST /cases | 创建新案例 |
get_case | GET /cases/{ID} | 获取案例详细信息 |
update_case | PUT /cases/{ID} | 通过操作更新案例字段 |
delete_case | DELETE /cases/{ID} | 删除案例(仅创建阶段) |
get_case_view | GET /cases/{ID}/views/{viewID} | 获取特定案例视图/线束 |
get_case_page | GET /cases/{ID}/pages/{pageID} | 在案例中获取嵌入式页面 |
get_case_action | GET /cases/{ID}/actions/{actionID} | 获取案例的行动表单元数据 |
refresh_case_action | PUT /cases/{ID}/actions/{actionID}/refresh | 字段更改后刷新案例操作表单 |
作业(5)
| 工具 | 端点 | 描述 |
|---|
get_assignments | GET /assignments | 列出用户的工作列表 |
get_assignment | GET /assignments/{ID} | 获取任务详细信息 |
get_assignment_action | GET /assignments/{ID}/actions/{actionID} | 获取流操作表单元数据 |
perform_assignment_action | POST /assignments/{ID} | 提交流程操作 |
refresh_assignment_action | PUT /assignments/{ID}/actions/{actionID}/refresh | 字段更改后刷新表单 |
案例类型(3)
| 工具 | 端点 | 描述 |
|---|
get_case_types | GET /casetypes | 列出可用的案例类型 |
get_case_type | GET /casetypes/{ID} | 获取案例类型元数据 |
refresh_case_type_view | PUT /casetypes/{ID}/refresh | 刷新新案例表单 |
数据页(3)
| 工具 | 端点 | 描述 |
|---|
get_data_page | GET /data/{dataViewID} | 检索数据页内容 |
post_data_page | POST /data/{dataViewID} | 将参数发布到数据页面 |
get_data_view_metadata | GET /data/{dataViewID}/metadata | 获取数据页元数据 |
附件(7)
| 工具 | 端点 | 描述 |
|---|
get_case_attachments | GET /cases/{ID}/attachments | 列出案例附件 |
add_case_attachment | POST /cases/{ID}/attachments | 在案例中添加文件或URL附件 |
delete_case_attachment | DELETE /cases/{ID}/attachments/{attachmentID} | 从案例中删除附件 |
upload_attachment | POST /attachments/upload | 上传文件作为临时附件 |
get_case_attachment_categories | GET /cases/{ID}/attachment_categories | 获取案例的附件类别 |
get_attachment | GET /attachments/{attachmentID} | 获取附件内容和元数据 |
delete_attachment | DELETE /attachments/{attachmentID} | 按ID删除附件 |
合作(11)
| 工具 | 端点 | 描述 |
|---|
get_documents | GET /documents | 列出协作文档 |
get_document | GET /documents/{ID} | 获取文档详细信息 |
get_messages | GET /messages | 列出用户的消息 |
create_message | POST /messages | 创建新消息 |
get_notifications | GET /notifications | 列出用户的通知 |
create_notification | POST /notifications | 创建新通知 |
get_spaces | GET /spaces | 列出协作空间 |
get_space | GET /spaces/{ID} | 获取空间详细信息 |
join_space | PUT /spaces/{ID}/join | 加入协作空间 |
leave_space | PUT /spaces/{ID}/leave | 留下协作空间 |
get_space_pins | GET /spaces/{ID}/pins | 在空间中固定物品 |
DevOps——应用(11)
| 工具 | 端点 | 描述 |
|---|
get_applications | GET /applications | 列出应用程序 |
get_application | GET /applications/{ID} | 获取应用程序详细信息 |
get_application_quality_metrics | GET /applications/{ID}/quality_metrics | 获取质量指标 |
get_application_guardrail_metrics | GET /applications/{ID}/guardrail_metrics | 获取护栏合规性指标 |
start_application_coverage | GET /applications/{ID}/start_application_coverage | 开始覆盖跟踪 |
stop_application_coverage | GET /applications/{ID}/stop_application_coverage | 停止覆盖跟踪 |
get_rule_coverage_report | GET /applications/{ID}/rule_coverage_detailed_report/{rulecoverageId} | 获取详细的覆盖报告 |
get_application_test_metrics | GET /applications/{ID}/test_metrics | 获取PegaUnit统计信息 |
get_application_security_tasks | GET /applications/{ID}/security_tasks | 获取安全任务状态 |
merge_test_coverage_reports | POST /applications/merged_testcoverage_reports | 合并覆盖率报告 |
get_test_metrics_for_rules | POST /applications/test_metrics_for_rules | 获取特定规则的测试指标 |
DevOps——PegaUnits和场景测试(3)
| 工具 | 端点 | 描述 |
|---|
execute_pegaunits | POST /pegaunits/execute | 异步运行PegaUnit测试 |
get_pegaunit_results | GET /pegaunits/execute/{ID}/results | 检索PegaUnit执行结果 |
execute_scenario_tests | POST /scenariotests/execute | 运行场景测试 |
DevOps——分支与合并(6)
| 工具 | 端点 | 描述 |
|---|
get_branch_conflicts | GET /branches/{ID}/conflicts | 获取分支合并冲突 |
merge_branch | POST /branches/{ID}/merge | 合并分支 |
get_branch_reviews | GET /branches/{ID}/reviews | 列出分支代码审查 |
create_branch_review | POST /branches/{ID}/reviews | 创建分支审核 |
get_branch_summary | GET /branches/{ID}/summary | 获取分支摘要 |
get_merge_status | GET /merges/{ID} | 获取合并操作状态 |
系统管理——报告(8)
| 工具 | 端点 | 描述 |
|---|
get_classes | GET /classes | 列出Pega类定义 |
get_databases | GET /databases | 列出数据库连接 |
get_tables | GET /tables | 列出数据库表 |
get_node_module_version_report | GET /nodes/{nodeID}/reports/module_version | 获取模块版本报告 |
get_node_conclusion_report | GET /nodes/{nodeId}/reports/conclusion_report/types/{typeName} | 获取结论缓存报告 |
get_node_log_usage_report | GET /nodes/{nodeId}/reports/log_usage | 获取日志使用情况报告 |
get_node_mru_report | GET /nodes/{nodeId}/reports/mru_report | 获取MRU报告 |
get_node_property_reference_report | GET /nodes/{nodeId}/reports/property_reference | 获取房产参考报告 |
系统管理-记录器(6)
| 工具 | 端点 | 描述 |
|---|
add_log_filter | POST /log_appender/{appenderName}/filter | 将请求者/线程过滤器添加到日志附加器 |
remove_log_filter | DELETE /log_appender/{appenderName}/filter | 从日志附加器中删除筛选器 |
get_log_categories | GET /nodes/{nodeId}/log_categories | 获取所有日志记录类别 |
reset_log_categories | DELETE /nodes/{nodeId}/log_categories | 将日志记录类别重置为默认值 |
get_log_category | GET /nodes/{nodeId}/log_categories/{category_name} | 获取特定类别记录器详细信息 |
set_log_level | PUT /nodes/{nodeId}/log_categories/{category_name} | 设置类别的日志级别 |
系统管理-节点(10)
| 工具 | 端点 | 描述 |
|---|
get_nodes | GET /nodes | 列出群集中的所有节点ID |
get_node_dataconfigs | GET /nodes/{nodeID}/dataconfigs | 获取数据库配置设置 |
get_node_datasources | GET /nodes/{nodeID}/datasources | 获取数据源标识 |
get_node_thread_dump | GET /nodes/{nodeID}/diagnostics/thread_dump | 获取线程转储 |
get_node_purge_results | GET /nodes/{nodeID}/purgeresults | 获取上次清除结果 |
get_node_search_status | GET /nodes/{nodeId}/search | 获取搜索节点状态 |
quiesce_node | POST /nodes/{nodeID}/quiesce | 将节点置于静止状态 |
get_node_prconfig | GET /nodes/{nodeID}/settings/prconfig | 下载PRConfig文件 |
get_node_system_settings | GET /nodes/{nodeID}/settings/system | 获取系统配置设置 |
unquiesce_node | POST /nodes/{nodeID}/unquiesce | 使节点脱离静止状态 |
系统管理-缓存(14)
| 工具 | 端点 | 描述 |
|---|
get_rule_cache_summary | GET /nodes/{nodeID}/caches/rule | 获取规则缓存摘要 |
clear_rule_cache | POST /nodes/{nodeID}/caches/rule/clear | 清除规则缓存 |
delete_rule_cache_instance | DELETE /nodes/{nodeID}/caches/rule/instances/{ruleInsKey} | 从缓存中删除规则实例 |
get_rule_cache_type_details | GET /nodes/{nodeID}/caches/rule/rule_types/{ruleType} | 获取类型的规则缓存详细信息 |
get_rule_cache_instances | GET /nodes/{nodeID}/caches/rule/rule_types/{ruleType}/instances | 列出规则类型的缓存实例 |
get_declarative_page_cache | GET /nodes/{nodeID}/caches/declarative_page | 获取声明性页面缓存摘要 |
clear_declarative_page_cache | POST /nodes/{nodeID}/caches/declarative_page/clear | 清除声明性页面缓存 |
get_declarative_rule_cache | GET /nodes/{nodeID}/caches/declarative_rule | 获取声明性规则缓存摘要 |
clear_declarative_rule_cache | POST /nodes/{nodeID}/caches/declarative_rule/clear | 清除声明性规则缓存 |
clear_aba_cache | POST /nodes/{nodeID}/caches/aba/clear | 清除ABA缓存 |
get_conclusion_cache | GET /nodes/{nodeID}/caches/conclusion | 获取结论缓存摘要 |
clear_conclusion_cache | POST /nodes/{nodeID}/caches/conclusion/clear | 清除结论缓存 |
reassemble_vtable_rule | POST /nodes/all/caches/vtable/rule_types/{pxobjclass}/instances/{pxinsid}/reassemble | 在所有节点上重新组装规则 |
reload_vtable_rule | POST /nodes/all/caches/vtable/rule_types/{pxobjclass}/instances/{pxinsid}/reload | 在所有节点上重新加载规则 |
系统管理——代理(5)
| 工具 | 端点 | 描述 |
|---|
get_node_agents | GET /nodes/{nodeID}/agents/ | 列出节点上的代理 |
get_node_agent | GET /nodes/{nodeID}/agents/{agentID} | 获取代理详细信息 |
start_node_agent | POST /nodes/{nodeID}/agents/{agentID} | 启动代理 |
restart_node_agent | PUT /nodes/{nodeID}/agents/{agentID} | 重新启动代理 |
stop_node_agent | DELETE /nodes/{nodeID}/agents/{agentID} | 阻止代理人 |
系统管理——作业调度程序(3)
| 工具 | 端点 | 描述 |
|---|
get_node_job_schedulers | GET /nodes/{nodeID}/job_schedulers | 列出节点上的作业调度程序 |
start_node_job_scheduler | POST /nodes/{nodeID}/job_schedulers/{jobID} | 启动作业调度程序 |
stop_node_job_scheduler | DELETE /nodes/{nodeID}/job_schedulers/{jobID} | 停止作业调度程序 |
系统管理——池(3)
| 工具 | 端点 | 描述 |
|---|
clear_all_requestor_pools | POST /nodes/{nodeID}/pools/requestor/clear | 清除所有请求者池 |
get_requestor_pools | GET /nodes/{nodeID}/pools/requestor/members | 列出请求者池成员 |
clear_requestor_pool | DELETE /nodes/{nodeID}/pools/requestor/members/{servicePackageName} | 清除特定请求者池 |
系统管理——队列处理器(3)
| 工具 | 端点 | 描述 |
|---|
get_node_queue_processors | GET /nodes/{nodeID}/queue_processors | 列出节点上的队列处理器 |
start_queue_processor | POST /nodes/{nodeID}/queue_processors/{queueID} | 启动队列处理器 |
stop_queue_processor | DELETE /nodes/{nodeID}/queue_processors/{queueID} | 停止队列处理器 |
系统管理——请求者(4)
| 工具 | 端点 | 描述 |
|---|
get_node_requestors | GET /nodes/{nodeID}/requestors | 列出节点上的活动请求者 |
get_node_requestor | GET /nodes/{nodeID}/requestors/{requestorID} | 获取请求者详细信息 |
stop_node_requestor | DELETE /nodes/{nodeID}/requestors/{requestorID} | 阻止请求者 |
interrupt_node_requestor | PUT /nodes/{nodeID}/requestors/{requestorID}/interrupt | 打断请求者 |
系统管理——PAL(2)
| 工具 | 端点 | 描述 |
|---|
get_pal_memory_allocation | GET /nodes/{nodeId}/pal/memory_allocation | 检查PAL内存分配度量状态 |
set_pal_memory_allocation | PUT /nodes/{nodeId}/pal/memory_allocation | 启用/禁用PAL内存分配指标 |
用户管理(5)
| 工具 | 端点 | 描述 |
|---|
generate_otp | POST /authenticate/OTP/{sendMode} | 生成OTP并将其发送给用户 |
verify_otp | GET /authenticate/OTP/verify | 验证用户输入的OTP |
disable_users | POST /users/disable | 终止会话并禁用用户 |
enable_users | POST /users/enable | 重新启用禁用用户 |
logout_users | POST /users/logout | 终止用户的所有会话 |
决策策略管理(4)
| 工具 | 端点 | 描述 |
|---|
get_dsm_services | GET /nodes/all/DSMServices | 列出跨节点的所有DSM服务 |
get_dsm_service | GET /nodes/all/DSMServices/{serviceId} | 获取DSM服务详细信息 |
get_dsm_nodes | GET /DSMServices/all/nodes | 列出运行任何DSM服务的节点 |
get_node_details | GET /nodes/{nodeId} | 获取节点详细信息(DSM上下文) |
数据隐私(9)
| 工具 | 端点 | 描述 |
|---|
create_client_access_request | POST /client_access_requests | 创建GDPR数据访问请求 |
get_client_access_request | GET /client_access_requests/{requestID} | 获取访问请求状态 |
create_client_rectify_request | POST /client_rectify_requests | 创建GDPR数据更正请求 |
get_client_rectify_request | GET /client_rectify_requests/{requestID} | 获取整改请求状态 |
create_client_erase_request | POST /client_erase_requests | 创建GDPR删除请求权 |
get_client_erase_request | GET /client_erase_requests/{requestID} | 获取擦除请求状态 |
get_data_privacy_metadata | GET /data_privacy_metadata | 获取客户端标识符字段名称 |
get_client_usage_restrictions | GET /client_usage_restrictions | 获取数据使用限制 |
update_client_usage_restrictions | PUT /client_usage_restrictions | 更新数据使用限制 |
______________________________________________________________________
认证
用途 HTTP基本身份验证 — Authorization: Basic base64(username:password).
设置这三个环境变量:
PEGA_BASE_URL=https://your-server.pegacloud.net/prweb
PEGA_USERNAME=your_operator_id
PEGA_PASSWORD=your_password
这三个都是 必需的 --如果缺少,服务器将在启动时抛出。
______________________________________________________________________
安装和建造
cd pega-dx-v1-mcp
npm install
npm run build
在Claude桌面中运行
第一步——先决条件
- 安装
- 克劳德桌面版 安装
- 正在运行的Pega实例(8.3-8.6,基于部分的UI)
______________________________________________________________________
步骤2--克隆和构建
git clone https://github.com/alamaticz/Pega-DX-API-v1-MCP.git
cd Pega-DX-API-v1-MCP
npm install
npm run build
建成后,a dist/index.js 将创建文件。注意 完全绝对路径 对于此文件,您将在下一步中需要它。
- Windows示例:
C:\Users\YourName\Pega-DX-API-v1-MCP\dist\index.js - macOS/Linux示例:
/Users/yourname/Pega-DX-API-v1-MCP/dist/index.js
______________________________________________________________________
步骤3--编辑Claude桌面配置
在文本编辑器中打开Claude Desktop配置文件:
| 操作系统 | 配置文件位置 |
|---|
| 视窗 | %APPDATA%\Claude\claude_desktop_config.json |
| macOS | ~/Library/Application Support/Claude/claude_desktop_config.json |
如果文件不存在,请创建它。
添加以下内容(替换 args 带有您自己值的路径和凭据):
窗户:
{
"mcpServers": {
"pega-dx-v1": {
"command": "node",
"args": ["C:\\Users\\YourName\\Pega-DX-API-v1-MCP\\dist\\index.js"],
"env": {
"PEGA_BASE_URL": "https://your-server.pegacloud.net/prweb",
"PEGA_USERNAME": "your_operator_id",
"PEGA_PASSWORD": "your_password"
}
}
}
}
macOS/Linux:
{
"mcpServers": {
"pega-dx-v1": {
"command": "node",
"args": ["/Users/yourname/Pega-DX-API-v1-MCP/dist/index.js"],
"env": {
"PEGA_BASE_URL": "https://your-server.pegacloud.net/prweb",
"PEGA_USERNAME": "your_operator_id",
"PEGA_PASSWORD": "your_password"
}
}
}
}
注: 如果配置中已有其他MCP服务器,请添加 "pega-dx-v1" 现有内部的块 "mcpServers" object--不要创建第二个 "mcpServers" 钥匙。
______________________________________________________________________
步骤4--重新启动克劳德桌面
完全退出并重新打开Claude Desktop。Pega MCP工具将出现在工具面板(锤子图标)中。
______________________________________________________________________
步骤5——验证连接
在新的克劳德对话中,问:
*“Ping我的Pega服务”*
克劳德会打电话的 ping_pega_service 并确认连接。如果失败,请仔细检查您的 PEGA_BASE_URL,凭据,并且您的Pega服务器可以从您的计算机访问。
______________________________________________________________________
开发(无构建)
npm run dev
______________________________________________________________________
V1与V2快速参考
| 功能 | V1(此MCP) | V2(MarcoLooy MCP) |
|---|
GET /cases list | 是(V1除外) | 否--使用数据视图 |
| 舞台管理 | 否 | 是 |
| 关注者/标签 | 否 | 是 |
| 参与者 | 否 | 是 |
| 屏幕流导航 | 否 | 是 |
| 批量操作 | 否 | 是 |
| 高级数据视图 | 否 | 是 |
| DevOps API | 是 | 否 |
| 系统管理 | 是 | 否 |
| 数据隐私(GDPR) | 是 | 否 |
| 协作空间 | 是 | 否 |
| Pega版本 | 8.3+ | 8.7+ |
| UI目标 | 基于部分 | 星座 |