// MCP TOOL REFERENCE

PEGA DX MCP SERVER TOOLS

65 tools from the Pega DX MCP Server MCP Server, categorised by risk level.

// ALL 65 PEGA DX MCP SERVER TOOLS

READ 29 tools

Read diagnose_pega_config Diagnose Pega configuration and environment variables to troubleshoot connection issues. Shows what configu... Read get_assignment Get assignment details including form fields, required fields, available actions, and eTag. Used BETWEEN ca... Read get_assignment_action Get detailed information about a specific action that can be performed on an assignment. Retrieves assignme... Read get_attachment Get the attachment content based on the attachmentID. Returns different content types: Base64 data for file... Read get_attachment_categories Retrieve the list of attachment categories available for a specific Pega case, filtered by attachment type ... Read get_case Get comprehensive case information including status, stage, assignments, and available actions. Use AFTER w... Read get_case_action Get detailed information about a case action, including view metadata and available actions Read get_case_ancestors Get ancestor case hierarchy for a specific case. Retrieves ancestor hierarchy case list for the case ID pas... Read get_case_attachments Get a comprehensive list of all attachments associated with a specific Pega case. Retrieves attachment meta... Read get_case_descendants Get descendants of a case instance. This API loops through all the child cases recursively descending from ... Read get_case_followers Get the list of all the Case Followers. Retrieves information about users who are following a case to recei... Read get_case_participants Get all participants associated with a specific Pega case. Returns comprehensive list of case participants ... Read get_case_stages Retrieve the stages list for a given case ID with processes, steps, and visited status information. Read get_case_tags Get list of tags associated to a case Read get_case_type_action Get detailed information about a case action, including view metadata and available actions Read get_case_type_bulk_action Get bulk action metadata for a specific case type and action ID Read get_case_types Get list of case types that the user can create in the application. Use returned classID as caseTypeID in c... Read get_case_view Get view details based on case ID and view name. Returns view metadata with customizable logic from pyUpgra... Read get_case_view_calculated_fields Get calculated fields for a given case view. Retrieves only the requested calculated fields from the case v... Read get_cases Get all cases created by authenticated user (V1 EXCLUSIVE - max 500 cases, oldest to newest). V2 users shou... Read get_data_objects Retrieve list of available data objects with metadata and HATEOAS links. Can optionally filter by data obje... Read get_data_view_metadata Retrieve data view metadata which includes data view parameters and list of queryable fields. Supports both... Read get_document Get contents of a document as base64 encoded string. Downloads document content based on the documentID par... Read get_next_assignment Get detailed information about the next assignment to be performed by the requestor. Uses Get Next Work fun... Read get_participant Get detailed information about a specific participant in a Pega case by case ID and participant ID. Returns... Read get_participant_role_details Get detailed information about a specific participant role in a Pega case, including role configuration, pe... Read get_participant_roles Retrieve list of participant roles for a specific Pega case. Returns available roles that can be assigned t... Read get_related_cases Get list of related cases for a specific case based on case ID Read ping_pega_service Test connectivity and system availability of Pega Infinity server using existing authentication. Makes a li...

WRITE 15 tools

Write add_case_attachments Attach files and/or URLs to a Pega case regardless of the context or stage of the case lifecycle. Can attac... Write add_case_followers Add multiple followers to a work object. Allows users to follow a case to receive notifications and updates... Write add_case_tags Add multiple tags to a case Write bulk_cases_patch Perform case action on multiple cases simultaneously using PATCH /api/application/v2/cases endpoint. In Inf... Write create_case Create a new Pega case. This is the FIRST step in case workflows. Automatically creates the initial assignm... Write create_case_participant Create a new participant in a Pega case with specified role and participant information. If no eTag is prov... Write relate_cases Create relationships between cases by relating a set of case instances to a primary case Write release_case_lock Release pessimistic lock on a Pega case and clean up any cached or pending updates. Used when canceling cas... Write save_assignment_action Save assignment action form data without executing the action. Implements Write update_attachment Updates the name and category of an existing attachment for a given attachmentID. The API only updates the ... Write update_case Update a Pega case by directly modifying case properties. V1 EXCLUSIVE - only available in Traditional DX A... Write update_data_record_full Fully update an existing data record based on conditional save plan configured for a savable Data Page. Ove... Write update_data_record_partial Partially update an existing data record based on conditional save plan configured for a savable Data Page.... Write update_participant Update participant details in a Pega case by case ID and participant ID. If no eTag is provided, automatica... Write upload_attachment Upload a file to Pega as a temporary attachment that can later be linked to cases. Creates a temporary atta...

DESTRUCTIVE 8 tools

Destructive delete_attachment Remove the specified attachment from a case. The API validates user authentication and privileges to delete... Destructive delete_case Delete a case that is currently in the create stage Destructive delete_case_follower Remove a follower from a case, ending their subscription to case notifications and updates. Removes the fol... Destructive delete_case_tag Delete a specific tag from a case by case ID and tag ID Destructive delete_data_record Delete a data record based on conditional save plan configured for a savable Data Page. Only supported on d... Destructive delete_participant Delete a participant from a Pega case by case ID and participant ID. If no eTag is provided, automatically ... Destructive delete_related_case Remove related work association between two cases by deleting a specific relationship Destructive remove_case_document Remove a document that is linked to a specific Pega case. This operation permanently removes the link betwe...

EXECUTE 12 tools

Execute navigate_assignment_previous Navigate back to the previously visited step in a screen flow or multi-step form assignment. If no finalETa... Execute refresh_assignment_action Refresh assignment action form data with updated values after property changes, execute Data Transforms, an... Execute refresh_case_action Refresh case action form data with updated values after property changes, execute Data Transforms, and hand... Execute change_to_next_stage Navigate a Pega case to its next stage in the primary stage sequence. Cannot be used when case is in altern... Execute change_to_stage Change to a specified stage of a case based on stageID passed. Allows navigation to any valid stage (primar... Execute jump_to_step Jump to the specified step within an assignment\ Execute perform_assignment_action Perform an assignment action to submit completed work and progress workflow. This is the FINAL step after a... Execute perform_case_action Perform an action on a Pega case, updating case data and progressing the workflow. Takes the case ID and ac... Execute recalculate_assignment_fields Recalculate calculated fields & whens for the current assignment action form. If no eTag is provided, autom... Execute recalculate_case_action_fields Recalculate calculated fields & whens for the current case action form. If no eTag is provided, automatical... Execute add_optional_process Add stage or case-wide optional process and return details of the next assignment in the process. The API i... Execute perform_bulk_action Perform case action on multiple cases simultaneously (bulk operation). Executes the specified action on all...

OTHER 1 tools

Other authenticate_pega Authenticate with Pega Infinity server using OAuth2 client credentials or direct access token. Stores the a...

// FAQ

How many tools does the Pega DX MCP Server MCP server have? +

The Pega DX MCP Server MCP server exposes 65 tools across 5 categories: Read, Write, Destructive, Execute, Other.

How do I enforce policies on Pega DX MCP Server tools? +

Route the Pega DX MCP Server server through the PolicyLayer gateway. Define allow, deny, or approval rules per tool in the dashboard; they are enforced on every call before it reaches the server.

What risk categories do Pega DX MCP Server tools fall into? +

Pega DX MCP Server tools are categorised as Read (29), Write (15), Destructive (8), Execute (12), Other (1). Each category has a recommended default policy.

Enforce policy on every Pega DX MCP Server tool call.

Start from Pega DX MCP Server, add the rest of your stack, and see everything your agents can call. Then put policy on all of it.

CHECK YOUR STACK →

Free to start. No card required.

43,000+ MCP servers and 220,000+ tools scanned and risk-classified.