Skip to main content
Glama
Sign In
Pega DX MCP Server

Pega DX MCP Server

by marco-looy
OverviewSchemaSourceRelated ServersDiscussionsAdmin
JavaScript
Hybrid

get_case_view

Retrieve view metadata for a case by providing case ID and view name. Returns data including logic from pyUpgradeOnOpen Data Transform.

Instructions

Get view details based on case ID and view name. Returns view metadata with customizable logic from pyUpgradeOnOpen Data Transform.

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>",
      "viewID": "<viewID>"
    },
    "name": "get_case_view"
  }
}

Input Schema

NameRequiredDescriptionDefault
caseIDYesCase ID. Example: "MYORG-APP-WORK C-1001". Complete identifier including spaces.
viewIDYesName of the view to retrieve
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.2/5.0
Behavior3/5

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

No annotations exist, so the description is the sole source for behavioral disclosure. It mentions returning metadata with customizable logic, implying a read-only operation, but does not explicitly state no side effects or authentication requirements.

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 sentence that directly states the purpose and key details without any extraneous information.

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

Completeness2/5

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

With no output schema, the description should explain return values more thoroughly. 'Returns view metadata with customizable logic' is vague and does not specify structure or content of the response.

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 description coverage is 100%, so the baseline is 3. The description adds minimal additional meaning beyond restating that it uses case ID and view name.

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

Purpose4/5

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

The description clearly states the tool retrieves view details given a case ID and view name, using a specific verb and resource. However, it does not differentiate from the sibling tool 'get_case_view_calculated_fields'.

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?

No guidance on when to use this tool versus alternatives (e.g., get_case_view_calculated_fields). No context on prerequisites or exclusions.

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