Skip to main content
Glama
marco-looy

Pega DX MCP Server

by marco-looy

create_case

Create a new Pega case to initiate case workflows, automatically generating an initial assignment and returning case and assignment IDs for progression.

Instructions

Create a new Pega case. This is the FIRST step in case workflows. Automatically creates the initial assignment (returned in nextAssignmentInfo). Many case types accept empty content {}. If fields required, automatic field discovery provides guidance. Returns: caseID, assignmentID (in nextAssignmentInfo.ID), eTag. Next steps: use get_assignment with assignmentID to view form fields.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
caseTypeIDYesCase type ID (Example: "Org-App-Work-CaseType"). Use get_case_types to discover available types.
parentCaseIDNoParent case ID for child case creation
processIDNoStarting process ID to use for case creation (Example: "pyStartCase"). Optional parameter that specifies which flow to use when creating the case. Some case types may require this to bypass initial validation.
contentNoField values for case creation (optional). Empty {} often works. If fields required, automatic discovery provides guidance. For embedded pages use pageInstructions.
pageInstructionsNoOptional list of page-related operations for embedded pages, page lists, or page groups. Required for setting embedded page references (Example: Collection, Datasource). See Pega DX API documentation on page instructions for embedded pages.
attachmentsNoA list of attachments to be added to specific attachment fields (optional)
viewTypeNoUI resources to return. "none" returns no UI resources, "form" returns form UI metadata, "page" returns full page UI metadatanone
pageNameNoIf provided, view metadata for specific page name will be returned (only used when viewType is "page")
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. Changed13 schema fields changedv1.0.0
    • changedInput schema / properties / caseTypeID / description
      Previous value: -"The class of the case being created (required)"New value: +"Case type ID (Example: \"Org-App-Work-CaseType\"). Use get_case_types to discover available types."
    • changedInput schema / properties / content / description
      Previous value: -"A map of scalar properties and embedded page properties to be set upon case creation (optional). If not provided, the tool will discover available fields and return guidance with examples."New value: +"Field values for case creation (optional). Empty {} often works. If fields required, automatic discovery provides guidance. For embedded pages use pageInstructions."
    • changedInput schema / properties / pageInstructions / description
      Previous value: -"A list of page-related operations to be performed on embedded pages, page lists, or page group properties (optional)"New value: +"Optional list of page-related operations for embedded pages, page lists, or page groups. Required for setting embedded page references (Example: Collection, Datasource). See Pega DX API documentation on page instructions for embedded pages."
    • changedInput schema / properties / pageInstructions / items / description
      Previous value: -"Page operation object with instruction type and target"New value: +"Page operation for embedded pages. IMPORTANT: Use REPLACE instruction to set embedded page references like Collection or Datasource with full object including pzInsKey. Example: {\"instruction\": \"REPLACE\", \"target\": \"Collection\", \"content\": {\"CollectionName\": \"knowledge\", \"pyID\": \"DC-1\", \"pzInsKey\": \"PEGAFW-QNA-WORK DC-1\"}}"
    • 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 (Example: \"Collection\", \"Datasource\")"
    • addedInput schema / properties / pageInstructions / items / required
      Added value: +[
      +  "instruction",
      +  "target"
      +]
    • changedInput schema / properties / parentCaseID / description
      Previous value: -"The ID of the case serving as the parent case (optional)"New value: +"Parent case ID for child case creation"
    • addedInput schema / properties / processID
      Added value: +{
      +  "description": "Starting process ID to use for case creation (Example: \"pyStartCase\"). Optional parameter that specifies which flow to use when creating the case. Some case types may require this to bypass initial validation.",
      +  "type": "string"
      +}
    • 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. \"none\" returns no UI resources, \"form\" returns form UI metadata, \"page\" returns full page UI metadata"New value: +"UI resources to return. \"none\" returns no UI resources, \"form\" returns form UI metadata, \"page\" returns full page UI metadata"
  2. First observed

TDQS

A4.3/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It discloses creation of initial assignment, return values (caseID, assignmentID, eTag), and mentions auto-discovery. However, it does not discuss authorization needs, rate limits, error conditions, or side effects beyond creation. Adequate but not exhaustive.

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

Conciseness5/5

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

The description is a single paragraph that front-loads the purpose, then logically flows to results, guidance on parameters, and next steps. Every sentence adds value with no redundancy or fluff. Efficient and well-structured.

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 tool's complexity (9 parameters, nested objects) and lack of output schema, the description covers purpose, key parameters, return values, and workflow. It lacks explicit error handling or prerequisites, but the guidance on content and next steps is thorough enough for an AI agent to use effectively.

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

Parameters5/5

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

Schema description coverage is 100%, and the description adds significant meaning beyond the schema. It explains when to use empty content, provides an example for pageInstructions, details authentication modes for sessionCredentials, and clarifies the role of return values. This goes well beyond the schema definitions.

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 verb 'Create' and resource 'a new Pega case', and positions it as 'the FIRST step in case workflows'. This distinguishes it from sibling tools like get_case or update_case, providing clear purpose.

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

Usage Guidelines4/5

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

The description explains when to use this tool (as first step), provides guidance on content (many case types accept empty content, auto-discovery for required fields), and states next steps (use get_assignment). It lacks explicit when-not or comparisons to alternatives, but the workflow context is strong.

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