Skip to main content
Glama
marco-looy

Pega DX MCP Server

by marco-looy

create_case_participant

Adds a participant to a Pega case by assigning a role and providing contact information, automatically handling eTag for case access control.

Instructions

Create a new participant in a Pega case with specified role and participant information. If no eTag is provided, automatically fetches the latest eTag from the case for seamless operation. Adds users to case access control with appropriate permissions and role assignments.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
caseIDYesCase 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.
eTagNoOptional. Auto-fetched if omitted. For faster execution, use eTag from previous response.
contentYesParticipant information object containing user details such as name, email, phone, and other contact information. Structure matches Data-Party schema.
participantRoleIDYesRole ID to assign to the participant. This determines the permissions and access level the participant will have for the case.
viewTypeNoUI resources to return. "form" returns form UI metadata, "none" returns no UI resources (default: "form")form
pageInstructionsNoOptional list of page-related operations for embedded pages, page lists, or page groups. Required for setting embedded page references.
sessionCredentialsNoOptional 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.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed12 schema fields changedv1.0.0
    • changedInput schema / properties / caseID / description
      Previous value: -"Full case handle (case ID) to add participant to. Example: \"ON6E5R-DIYRecipe-Work-RecipeCollection R-1008\". Must be a complete case identifier including spaces and special characters."New value: +"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."
    • changedInput schema / properties / eTag / description
      Previous value: -"Required eTag unique value for optimistic locking from a previous case or participant API call. Prevents concurrent modification conflicts."New value: +"Optional. Auto-fetched if omitted. For faster execution, use eTag from previous response."
    • changedInput schema / properties / pageInstructions / description
      Previous value: -"Optional list of page-related operations for embedded pages, page lists, or page groups included in the participant creation view."New value: +"Optional list of page-related operations for embedded pages, page lists, or page groups. Required for setting embedded page references."
    • changedInput schema / properties / pageInstructions / items / description
      Previous value: -"Page operation object with instruction type and target"New value: +"Page operation for embedded pages. Use REPLACE instruction to set embedded page references with full object including pzInsKey. Example: {\"instruction\": \"REPLACE\", \"target\": \"PageName\", \"content\": {\"Property\": \"value\", \"pyID\": \"ID-123\", \"pzInsKey\": \"CLASS-NAME ID-123\"}}"
    • addedInput schema / properties / pageInstructions / items / properties / content
      Added value: +{
      +  "description": "Content to set on the embedded page (required for UPDATE and REPLACE)",
      +  "type": "object"
      +}
    • changedInput schema / properties / pageInstructions / items / properties / instruction / description
      Previous value: -"The type of page instruction to perform"New value: +"Page instruction type. UPDATE (add fields to page), REPLACE (replace entire page), DELETE (remove page), APPEND (add item to page list), INSERT (insert item in page list), MOVE (reorder page list items)"
    • addedInput schema / properties / pageInstructions / items / properties / instruction / enum
      Added value: +[
      +  "UPDATE",
      +  "REPLACE",
      +  "DELETE",
      +  "APPEND",
      +  "INSERT",
      +  "MOVE"
      +]
    • changedInput schema / properties / pageInstructions / items / properties / target / description
      Previous value: -"The target page or page list for the instruction"New value: +"Target embedded page name"
    • addedInput schema / properties / pageInstructions / items / required
      Added value: +[
      +  "instruction",
      +  "target"
      +]
    • addedInput schema / properties / sessionCredentials
      Added value: +{
      +  "description": "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.",
      +  "properties": {
      +    "accessToken": {
      +      "description": "Direct access token (required for token mode)",
      +      "type": "string"
      +    },
      +    "apiVersion": {
      +      "default": "v2",
      +      "description": "API version (optional, defaults to v2)",
      +      "type": "string"
      +    },
      +    "baseUrl": {
      +      "description": "Pega base URL (required if providing credentials)",
      +      "type": "string"
      +    },
      +    "clientId": {
      +      "description": "OAuth2 client ID (required for OAuth mode)",
      +      "type": "string"
      +    },
      +    "clientSecret": {
      +      "description": "OAuth2 client secret (required for OAuth mode)",
      +      "type": "string"
      +    },
      +    "sessionId": {
      +      "description": "Optional session ID. If not provided, a new session will be created.",
      +      "type": "string"
      +    },
      +    "tokenExpiry": {
      +      "description": "Token expiry in seconds from now (optional for token mode)",
      +      "type": "number"
      +    }
      +  },
      +  "type": "object"
      +}
    • changedInput schema / properties / viewType / description
      Previous value: -"Type of view data to return. \"form\" returns form UI metadata, \"none\" returns no UI resources (default: \"form\")"New value: +"UI resources to return. \"form\" returns form UI metadata, \"none\" returns no UI resources (default: \"form\")"
    • changedInput schema / required
      Previous value: -[
      -  "caseID",
      -  "eTag",
      -  "content",
      -  "participantRoleID"
      -]New value: +[
      +  "caseID",
      +  "content",
      +  "participantRoleID"
      +]
  2. First observed

TDQS

A3.9/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description must disclose behavior. It mentions creating a participant and adding users to case access control. But it lacks details on prerequisites (e.g., required permissions), side effects (e.g., triggering workflows), or whether the operation is reversible. The eTag auto-fetch is a helpful behavioral detail.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is relatively concise with four sentences, each adding unique information. It is front-loaded with the primary purpose. While more details could be added, it does not contain unnecessary fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (7 parameters, nested objects, no output schema), the description covers the core functionality, eTag behavior, and access control implication. It lacks error handling or prerequisites (e.g., case ID format) but is reasonably complete for agent invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, but the description adds significant value: for eTag it explains auto-fetch and performance benefit; for content it specifies the Data-Party schema; for participantRoleID it links to permissions; and for pageInstructions and sessionCredentials it provides detailed examples and modes. This exceeds what the schema alone provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool creates a new participant in a Pega case with a specified role and participant information. It distinguishes from siblings like add_case_followers, update_participant, and delete_participant by focusing on creation and access control.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides some usage guidance, such as the auto-fetch behavior for eTag and the option to provide it for faster execution. However, it does not explicitly contrast with alternative tools like add_case_followers or update_participant, leaving room for confusion on when to use each.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/marco-looy/pega-dx-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server