Pega DX MCP Server

Instructions

Implementation Reference

• src/tools/cases/get-case-action.js:51-104 (handler)

  The execute method implements the core logic of the get_case_action tool: parameter validation, session handling, viewType mapping, and calling pegaClient.getCaseAction with error handling.
  async execute(params) { const { caseID, actionID, viewType, excludeAdditionalActions } = params; let sessionInfo = null; try { // Initialize session configuration if provided sessionInfo = this.initializeSessionConfig(params); // Validate required parameters using base class const requiredValidation = this.validateRequiredParams(params, ['caseID', 'actionID']); if (requiredValidation) { return requiredValidation; } // Validate enum parameters using base class const enumValidation = this.validateEnumParams(params, { viewType: ['none', 'form', 'page'] }); if (enumValidation) { return enumValidation; } // Validate excludeAdditionalActions if provided if (excludeAdditionalActions !== undefined && typeof excludeAdditionalActions !== 'boolean') { return { error: 'Invalid excludeAdditionalActions parameter. Must be a boolean value.' }; } // Map viewType 'none' to 'form' since getCaseAction API doesn't accept 'none' const apiViewType = viewType === 'none' ? 'form' : viewType; // Execute with standardized error handling return await this.executeWithErrorHandling( `Case Action Details: ${actionID} for ${caseID}`, async () => await this.pegaClient.getCaseAction(caseID.trim(), actionID.trim(), { viewType: apiViewType, excludeAdditionalActions }), { caseID, actionID, viewType, excludeAdditionalActions, sessionInfo } ); } catch (error) { return { content: [{ type: 'text', text: `## Error: Get Case Action **Unexpected Error**: ${error.message} ${sessionInfo ? `**Session**: ${sessionInfo.sessionId} (${sessionInfo.authMode} mode)\n` : ''}*Error occurred at: ${new Date().toISOString()}*` }] }; } }
• src/tools/cases/get-case-action.js:15-46 (schema)

  Static getDefinition method provides the MCP tool definition: name 'get_case_action', description, and detailed inputSchema with properties for caseID, actionID, viewType, excludeAdditionalActions, and sessionCredentials.
  static getDefinition() { return { name: 'get_case_action', description: 'Get detailed information about a case action, including view metadata and available actions', inputSchema: { type: 'object', properties: { caseID: { type: 'string', description: 'Full case handle (e.g.,ON6E5R-DIYRECIPE-WORK-RECIPECOLLECTION R-1008)' }, actionID: { type: 'string', description: 'Flow action name of a case/stage action that the client requests - ID of the flow action rule. IMPORTANT: Action IDs typically do not contain spaces even if the display name does. Use get_case to retrieve the correct action ID from the availableActions array. Common IDs: "pyUpdateCaseDetails", "pyChangeStage", "pyApproval", "pyReject".' }, viewType: { type: 'string', enum: ['none', 'form', 'page'], description: 'Type of view data to return. "none" returns no UI resources, "form" returns only form UI metadata, "page" returns full case page UI metadata', default: 'page' }, excludeAdditionalActions: { type: 'boolean', description: 'When true, excludes information on all actions performable on the case. Set to true if action information was already retrieved in a previous call', default: false }, sessionCredentials: getSessionCredentialsSchema() }, required: ['caseID', 'actionID'] } }; }
• src/api/pega-client.js:247-248 (helper)

  PegaClient.getCaseAction wrapper method called by the tool to perform the actual API request to fetch case action details.
  async getCaseAction(caseID, actionID, options = {}) { return this.client.getCaseAction(caseID, actionID, options);
• src/tools/cases/get-case-action.js:109-200 (handler)

  formatSuccessResponse method formats the response from getCaseAction, extracting case info, available actions, UI resources, eTag, and adding execution notes.
  formatSuccessResponse(operation, data, options = {}) { const { caseID, viewType, excludeAdditionalActions, sessionInfo } = options; // Extract eTag from the top-level response if available const responseETag = data.eTag; let response = `## ${operation}\n\n`; response += `*Operation completed at: ${new Date().toISOString()}*\n\n`; // Session Information (if applicable) if (sessionInfo) { response += `### Session Information\n`; response += `- **Session ID**: ${sessionInfo.sessionId}\n`; response += `- **Authentication Mode**: ${sessionInfo.authMode.toUpperCase()}\n`; response += `- **Configuration Source**: ${sessionInfo.configSource}\n\n`; } if (data.data) { // Display case information if (data.data.caseInfo) { const caseInfo = data.data.caseInfo; response += '### Case Information\n'; response += `- **Case ID**: ${caseInfo.ID || caseID}\n`; response += `- **Case Type**: ${caseInfo.caseTypeName || 'N/A'}\n`; response += `- **Status**: ${caseInfo.status || 'N/A'}\n`; response += `- **Stage**: ${caseInfo.stage || 'N/A'}\n`; response += `- **Step**: ${caseInfo.step || 'N/A'}\n`; response += `- **Urgency**: ${caseInfo.urgency || 'N/A'}\n`; response += `- **Last Updated**: ${caseInfo.lastUpdateTime || 'N/A'}\n`; // Display available actions if not excluded if (!excludeAdditionalActions && caseInfo.availableActions && caseInfo.availableActions.length > 0) { response += '\n### Available Actions\n'; caseInfo.availableActions.forEach((action, index) => { response += `${index + 1}. **${action.name}** - ${action.displayName || action.name}\n`; if (action.type) { response += ` - Type: ${action.type}\n`; } }); } // Display assignment actions if not excluded if (!excludeAdditionalActions && caseInfo.assignments && caseInfo.assignments.length > 0) { response += '\n### Assignment Actions\n'; caseInfo.assignments.forEach((assignment, index) => { response += `${index + 1}. **Assignment**: ${assignment.name || 'N/A'}\n`; if (assignment.actions && assignment.actions.length > 0) { assignment.actions.forEach((action, actionIndex) => { response += ` - ${actionIndex + 1}. ${action.name} (${action.displayName || action.name})\n`; }); } }); } } } // Display UI resources info based on viewType if (data.uiResources) { response += '\n### UI Resources\n'; response += `- **View Type**: ${viewType || 'page'}\n`; response += '- UI metadata has been loaded for action view\n'; if (data.uiResources.root) { response += `- **Root Component**: ${data.uiResources.root.type || 'Unknown'}\n`; if (data.uiResources.root.name) { response += `- **Component Name**: ${data.uiResources.root.name}\n`; } } if (viewType === 'form') { response += '- Form-specific UI metadata included\n'; } else { response += '- Full page UI metadata included\n'; } } // Display eTag information for future updates (check both response and data locations) const eTag = responseETag || (data.data && data.data.eTag) || data.etag; if (eTag) { response += '\n### Update Information\n'; response += `- **ETag**: ${eTag}\n`; response += '- This eTag can be used for subsequent operations on this action\n'; } response += '\n### Action Execution Notes\n'; response += '- Pre-processing actions have been executed\n'; response += '- Case lock has been acquired if pessimistic locking is enabled\n'; response += '- This action is ready for execution via perform_case_action tool\n'; return response; }