Pega DX MCP Server

add_case_attachments

Attach files and URLs to any Pega case in a single atomic operation, ensuring all attachments succeed or none are added.

Instructions

Attach files and/or URLs to a Pega case regardless of the context or stage of the case lifecycle. Can attach temporary uploaded files using their IDs (from upload_attachment tool), or add URL/link attachments directly. Supports multiple attachments in a single atomic operation - if any attachment fails, no attachments are added to the case.

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>",
      "attachments": "<attachments>"
    },
    "name": "add_case_attachments"
  }
}

Input Schema

Name	Required	Description
`caseID`	Yes	Case ID. Example: "MYORG-APP-WORK C-1001". Complete identifier including spaces."OSIEO3-DOCSAPP-WORK T-561003". a complete case identifier including spaces and special characters.
`attachments`	Yes	Array of attachment objects to add to the case. Can contain file attachments (using temporary attachment IDs from upload_attachment tool) and/or URL attachments. All attachments must be successfully processed or none will be attached (atomic operation).
`sessionCredentials`	No	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.

Schema Changelog

Changes observed during successful MCP inspections.

Changed4 schema fields changedv1.0.0Jan 3, 2026

changedInput schema / properties / attachments / items / properties / type / description

Previous value: -"Attachment type. Must be \"File\" for file attachments or \"URL\" for URL/link attachments."New value: +"Attachment type. \"File\" for file attachments or \"URL\" for URL/link attachments."

changedInput schema / properties / attachments / items / properties / url / description

Previous value: -"URL/link to attach to the case (required for URL type). Example: \"https://www.google.com\". Must be a valid URL format."New value: +"URL/link to attach to the case (required for URL type). Example: \"https://www.google.com\". a valid URL format."

changedInput schema / properties / caseID / description

Previous value: -"Full case handle (case ID) to attach files/URLs to. Example: \"OSIEO3-DOCSAPP-WORK T-561003\". 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.\"OSIEO3-DOCSAPP-WORK T-561003\". a complete case identifier including spaces and special characters."

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"
+}

First observedAug 15, 2025

TDQS

A4/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 full burden. It discloses atomicity (all-or-nothing) and hints at the 2-hour expiry of temporary attachments in the schema. However, it doesn't cover error handling, authentication details, idempotency, or required permissions. More behavioral context would be helpful.

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 two concise sentences, front-loaded with the purpose and then key behavioral detail (atomicity). Every word earns its place. No redundancy.

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 (nested objects, no output schema), the description is fairly complete. It covers the main functionality and atomicity. The parameter descriptions fill in details like temporary ID expiry. Could mention return value, but not critical.

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% with detailed parameter descriptions. The main description adds complementary context (e.g., using IDs from upload_attachment, types of attachments). Since coverage is high, baseline is 3, and the description adds marginal value beyond the schema.

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 attaches files and/or URLs to a Pega case, regardless of context or stage. It distinguishes from siblings like upload_attachment (which uploads temporary files) and get/update/delete attachment tools. The verb 'attach' and resource 'case attachments' are specific.

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: for attaching temporary files (via IDs from upload_attachment) or URLs directly. It mentions atomicity ('if any attachment fails, no attachments are added'). It could be more explicit about when not to use, but provides clear context.

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

Deploy Server