Skip to main content
Glama
Sign In
Pega DX MCP Server

Pega DX MCP Server

by marco-looy
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Hybrid

get_case_stages

Retrieve the stages list for a case ID with processes, steps, and visited status to track case progress.

Instructions

Retrieve the stages list for a given case ID with processes, steps, and visited status information.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "caseID": "<caseID>"
    },
    "name": "get_case_stages"
  }
}

Input Schema

NameRequiredDescriptionDefault
caseIDYesCase ID. Example: "MYORG-APP-WORK C-1001". Complete identifier including spaces.
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.

  1. Changed2 schema fields changedv1.0.0
    • changedInput schema / properties / caseID / description
      Previous value: -"Full case handle (e.g.,ON6E5R-DIYRECIPE-WORK-RECIPECOLLECTION R-1008)"New value: +"Case ID. Example: \"MYORG-APP-WORK C-1001\". Complete identifier including spaces."
    • 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"
+}
  2. First observed

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It indicates the tool returns stages with processes, steps, and visited status, implying a read-only operation. However, it does not disclose behavioral traits like authentication requirements, error behavior for invalid case IDs, or whether the response is paginated.

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 a single sentence that is concise and easily readable. It could be improved by adding a brief usage note, but it is appropriately sized.

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

Completeness3/5

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

For a retrieval tool with no output schema and no annotations, the description is adequate but incomplete. It explains the input and output structure but does not mention authentication prerequisites (though sessionCredentials is optional) or potential constraints like case ID format specifics.

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

Parameters3/5

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

Schema coverage is 100%, so the baseline is 3. The description adds no extra meaning beyond the schema for parameters; it only restates that the tool uses a case ID. The sessionCredentials parameter is well-documented in the schema itself.

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 retrieves a stages list for a given case ID, including processes, steps, and visited status. This is specific and distinguishes it from sibling tools like 'get_case' which retrieves basic case info.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'get_case_action' or 'jump_to_step'. No context on prerequisites, exclusions, or scenarios where other tools are preferred.

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

Deploy Server

Other Tools