get_case_stages
Retrieve case stages with processes, steps, and visited status for a specific case ID to track workflow progress and understand current status.
Instructions
Retrieve the stages list for a given case ID with processes, steps, and visited status information.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caseID | Yes | Case ID. Example: "MYORG-APP-WORK C-1001". Complete identifier including spaces. | |
| sessionCredentials | No | Optional session-specific credentials. If not provided, uses environment variables. Supports two authentication modes: (1) OAuth mode - provide baseUrl, clientId, and clientSecret, or (2) Token mode - provide baseUrl and accessToken. |
Implementation Reference
- src/tools/cases/get-case-stages.js:36-64 (handler)The main handler function that executes the tool: destructures caseID, initializes session config if provided, validates parameters, and calls pegaClient.getCaseStages with standardized error handling and response formatting.async execute(params) { const { caseID } = 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']); if (requiredValidation) { return requiredValidation; } // Execute with standardized error handling return await this.executeWithErrorHandling( `Case Stages: ${caseID}`, async () => await this.pegaClient.getCaseStages(caseID.trim()), { caseID, sessionInfo } ); } catch (error) { return { content: [{ type: 'text', text: `## Error: Get Case Stages\n\n**Unexpected Error**: ${error.message}\n\n${sessionInfo ? `**Session**: ${sessionInfo.sessionId} (${sessionInfo.authMode} mode)\n` : ''}*Error occurred at: ${new Date().toISOString()}*` }] }; } }
- Static method providing the MCP tool definition including name, description, and input schema requiring 'caseID'.static getDefinition() { return { name: 'get_case_stages', description: 'Retrieve the stages list for a given case ID with processes, steps, and visited status information.', inputSchema: { type: 'object', properties: { caseID: { type: 'string', description: 'Case ID. Example: "MYORG-APP-WORK C-1001". Complete identifier including spaces.' }, sessionCredentials: getSessionCredentialsSchema() }, required: ['caseID'] } }; }
- Overridden helper method for formatting successful responses specific to case stages, including stage overview, visited status, processes, steps, and overall progress summary.formatSuccessResponse(operation, data, options = {}) { const { caseID, sessionInfo } = options; 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`; } // Display case stages information if (data.stages && Array.isArray(data.stages)) { response += `### Stage Overview\n`; response += `- **Total Stages**: ${data.stages.length}\n`; // Count visited and unvisited stages const visitedStages = data.stages.filter(stage => stage.visited === true); const unvisitedStages = data.stages.filter(stage => stage.visited === false); response += `- **Visited Stages**: ${visitedStages.length}\n`; response += `- **Remaining Stages**: ${unvisitedStages.length}\n\n`; // Display each stage with details data.stages.forEach((stage, stageIndex) => { const stageNumber = stageIndex + 1; const visitedIcon = stage.visited ? '✅' : '⏸️'; const stageType = stage.stageType || 'Primary'; response += `### ${visitedIcon} Stage ${stageNumber}: ${stage.name}\n`; response += `- **Type**: ${stageType}\n`; response += `- **Status**: ${stage.visited ? 'Visited' : 'Not Visited'}\n`; if (stage.description) { response += `- **Description**: ${stage.description}\n`; } // Display processes within the stage if (stage.processes && Array.isArray(stage.processes)) { response += `- **Processes**: ${stage.processes.length}\n\n`; stage.processes.forEach((process, processIndex) => { const processNumber = processIndex + 1; const processVisitedIcon = process.visited ? '✅' : '⏸️'; response += `#### ${processVisitedIcon} Process ${stageNumber}.${processNumber}: ${process.name}\n`; response += ` - **Status**: ${process.visited ? 'Visited' : 'Not Visited'}\n`; if (process.description) { response += ` - **Description**: ${process.description}\n`; } // Display steps within the process if (process.steps && Array.isArray(process.steps)) { response += ` - **Steps**: ${process.steps.length}\n`; process.steps.forEach((step, stepIndex) => { const stepNumber = stepIndex + 1; const stepVisitedIcon = step.visited ? '✅' : '⏸️'; response += ` ${stepVisitedIcon} **Step ${stageNumber}.${processNumber}.${stepNumber}**: ${step.name}`; response += ` (${step.visited ? 'Visited' : 'Not Visited'})\n`; if (step.description) { response += ` - ${step.description}\n`; } }); } response += '\n'; }); } else { response += '\n'; } }); // Summary section response += '### Progress Summary\n'; const totalProcesses = data.stages.reduce((sum, stage) => sum + (stage.processes ? stage.processes.length : 0), 0); const visitedProcesses = data.stages.reduce((sum, stage) => sum + (stage.processes ? stage.processes.filter(p => p.visited).length : 0), 0); const totalSteps = data.stages.reduce((sum, stage) => sum + (stage.processes ? stage.processes.reduce((pSum, process) => pSum + (process.steps ? process.steps.length : 0), 0) : 0), 0); const visitedSteps = data.stages.reduce((sum, stage) => sum + (stage.processes ? stage.processes.reduce((pSum, process) => pSum + (process.steps ? process.steps.filter(s => s.visited).length : 0), 0) : 0), 0); if (totalProcesses > 0) { response += `- **Processes**: ${visitedProcesses}/${totalProcesses} completed\n`; } if (totalSteps > 0) { response += `- **Steps**: ${visitedSteps}/${totalSteps} completed\n`; } // Progress percentage if (totalSteps > 0) { const progressPercent = Math.round((visitedSteps / totalSteps) * 100); response += `- **Overall Progress**: ${progressPercent}%\n`; } } else if (data.stages) { response += '### Stages Information\n'; response += '- Stages data available but not in expected array format\n'; response += `- Raw data type: ${typeof data.stages}\n`; } else { response += '### No Stages Information\n'; response += '- No stages data found for this case\n'; } return response; }
- src/api/pega-client.js:218-219 (helper)API client wrapper method that calls the underlying Pega client to fetch case stages for the given caseID.async getCaseStages(caseID) { return this.client.getCaseStages(caseID);
- src/registry/tool-loader.js:123-133 (registration)Dynamic registration in ToolLoader: instantiates the tool class, retrieves name from getDefinition(), and registers in loadedTools map by name. This loader scans src/tools directories to auto-register all tools.const toolInstance = new ToolClass(); const toolName = ToolClass.getDefinition().name; this.loadedTools.set(toolName, { instance: toolInstance, class: ToolClass, category: category, filename: filename }); return toolInstance;