delete_participant
Remove a participant from a Pega case using case ID and participant ID. Automatically fetches the latest eTag if not provided to ensure data consistency through optimistic locking.
Instructions
Delete a participant from a Pega case by case ID and participant ID. If no eTag is provided, automatically fetches the latest eTag from the case for seamless operation. Requires an eTag value for optimistic locking to ensure data consistency. Returns success confirmation or detailed error information.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| caseID | Yes | Case ID. Example: "MYORG-APP-WORK C-1001". Complete identifier including spaces."ON6E5R-DIYRecipe-Work-RecipeCollection R-1008". a complete case identifier including spaces and special characters. | |
| participantID | Yes | Participant ID to remove from the case. This identifies the specific participant that will be deleted from the case participant list. | |
| eTag | No | Optional. Auto-fetched if omitted. For faster execution, use eTag from previous response. | |
| 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
- The async execute(params) method in DeleteParticipantTool class implements the core handler logic for the 'delete_participant' tool. It handles input validation, automatic eTag fetching if not provided, eTag validation, and delegates the deletion to pegaClient.deleteParticipant within standardized error handling.async execute(params) { const { caseID, participantID, eTag } = params; let sessionInfo = null; try { sessionInfo = this.initializeSessionConfig(params); // Validate required parameters using base class const requiredValidation = this.validateRequiredParams(params, ['caseID', 'participantID']); if (requiredValidation) { return requiredValidation; } // Execute with standardized error handling // Auto-fetch eTag if not provided let finalETag = eTag; let autoFetchedETag = false; if (!finalETag) { try { console.log(`Auto-fetching latest eTag for participant operation on ${caseID}...`); const caseResponse = await this.pegaClient.getCase(caseID.trim()); if (!caseResponse || !caseResponse.success) { const errorMsg = `Failed to auto-fetch eTag: ${caseResponse?.error?.message || 'Unknown error'}`; return { error: errorMsg }; } finalETag = caseResponse.eTag; autoFetchedETag = true; console.log(`Successfully auto-fetched eTag: ${finalETag}`); if (!finalETag) { const errorMsg = 'Auto-fetch succeeded but no eTag was returned from get_case. This may indicate a server issue.'; return { error: errorMsg }; } } catch (error) { const errorMsg = `Failed to auto-fetch eTag: ${error.message}`; return { error: errorMsg }; } } // Validate eTag format (should be a timestamp-like string) if (typeof finalETag !== 'string' || finalETag.trim().length === 0) { return { error: 'Invalid eTag parameter. a non-empty string representing case save date time.' }; } return await this.executeWithErrorHandling( `Delete Participant: ${caseID.trim()} / ${participantID.trim()}`, async () => await this.pegaClient.deleteParticipant(caseID.trim(), participantID.trim(), finalETag.trim()), { caseID: caseID.trim(), participantID: participantID.trim(), eTag: '***', sessionInfo } // Hide eTag in logs for security ); } catch (error) { return { content: [{ type: 'text', text: `## Error: Delete Participant: ${caseID} / ${participantID}\n\n**Unexpected Error**: ${error.message}\n\n${sessionInfo ? `**Session**: ${sessionInfo.sessionId} (${sessionInfo.authMode} mode)\n` : ''}*Error occurred at: ${new Date().toISOString()}*` }] }; } }
- The static getDefinition() method defines the tool's metadata including name 'delete_participant', description, and inputSchema for validation in the MCP protocol.static getDefinition() { return { name: 'delete_participant', description: 'Delete a participant from a Pega case by case ID and participant ID. If no eTag is provided, automatically fetches the latest eTag from the case for seamless operation. Requires an eTag value for optimistic locking to ensure data consistency. Returns success confirmation or detailed error information.', inputSchema: { type: 'object', properties: { caseID: { type: 'string', description: 'Case ID. Example: "MYORG-APP-WORK C-1001". Complete identifier including spaces."ON6E5R-DIYRecipe-Work-RecipeCollection R-1008". a complete case identifier including spaces and special characters.' }, participantID: { type: 'string', description: 'Participant ID to remove from the case. This identifies the specific participant that will be deleted from the case participant list.' }, eTag: { type: 'string', description: 'Optional. Auto-fetched if omitted. For faster execution, use eTag from previous response.' }, sessionCredentials: getSessionCredentialsSchema() }, required: ['caseID', 'participantID'] } }; }
- src/api/pega-client.js:866-870 (helper)The deleteParticipant method in PegaClient wrapper class performs feature availability check and delegates to the underlying client for the actual API call to delete a participant.async deleteParticipant(caseID, participantID, eTag) { if (!this.isFeatureAvailable('participants')) { this.throwUnsupportedFeatureError('participants', 'deleteParticipant'); } return this.client.deleteParticipant(caseID, participantID, eTag);