Skip to main content
Glama
Sign In
Polarion MCP Server

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

patchWorkItemRelationships

DestructiveIdempotent

Updates Work Item relationships in Polarion, replacing existing link data. Set dry_run first to validate arguments and preview the exact request before applying irreversible changes.

Instructions

Updates a list of Work Item Relationships. Effect: irreversible — data removed or overwritten by this call cannot be recovered through the API. Tip: set dry_run: true first to validate the arguments and preview the exact request without sending it to Polarion. The executor returns this preview as normal text, and as structured content when the tool declares an output schema.

Input Schema

NameRequiredDescriptionDefault
dry_runNoIf true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it.
projectIdYesThe Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global read access.
workItemIdYesThe Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads.
requestBodyYesThe Relationship body.
relationshipIdYesThe relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.4.4
    • changedInput schema / properties / projectId / description
      Previous value: -"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project. If the ID is unknown, ask the user; getProjects lists IDs only with global read access."
  2. Changed1 schema field changedv1.2.2
    • changedInput schema / properties / relationshipId / description
      Previous value: -"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."New value: +"The relationship's name as it appears under `relationships` in the owning resource (e.g. `assignee`, `author`, `watches`, `linkedWorkItems`), not an ID of an individual link entry."
  3. Changed4 schema fields changedv1.2.0
    • changedInput schema / properties / dry_run / description
      Previous value: -"If true, validate and return the request that would be sent without calling Polarion."New value: +"If true, validates the request and returns the exact request that would be sent to Polarion — with the Authorization header redacted and any binary payload summarized by byte length — without actually sending it."
    • changedInput schema / properties / projectId / description
      Previous value: -"The Project ID."New value: +"The Polarion project ID (its URL segment, e.g. `myproject`), case-sensitive. Required to scope the request to one project; call getProjects to list valid IDs."
    • changedInput schema / properties / relationshipId / description
      Previous value: -"The Relationship ID."New value: +"The ID of the specific relationship entry linking the two resources, as returned by the corresponding get-relationships call."
    • changedInput schema / properties / workItemId / description
      Previous value: -"The Work Item ID."New value: +"The Work Item's ID within its project (e.g. `WI-123`), not the combined `project/id` path used in some link payloads."
  4. Changed2 schema fields changed
    • addedInput schema / properties / dry_run
      Added value: +{
+  "description": "If true, validate and return the request that would be sent without calling Polarion.",
+  "type": "boolean"
+}
    • changedInput schema / properties / requestBody / oneOf
      Previous value: -[
-  {
-    "properties": {
-      "data": {
-        "properties": {
-          "id": {
-            "example": "MyProjectId/MyResourceId",
-            "type": "string"
-          },
-          "type": {
-            "enum": [
-              "categories",
-              "documents",
-              "document_attachments",
-              "document_comments",
-              "document_parts",
-              "enumerations",
-              "globalroles",
-              "icons",
-              "jobs",
-              "linkedworkitems",
-              "externallylinkedworkitems",
-              "linkedoslcresources",
-              "pages",
-              "page_attachments",
-              "plans",
-              "projectroles",
-              "projectgroups",
-              "projects",
-              "projecttemplates",
-              "spaces",
-              "testparameters",
-              "testparameter_definitions",
-              "testrecords",
-              "teststep_results",
-              "testruns",
-              "testrun_attachments",
-              "teststepresult_attachments",
-              "testrun_comments",
-              "usergroups",
-              "users",
-              "workitems",
-              "workitem_attachments",
-              "workitem_approvals",
-              "workitem_comments",
-              "featureselections",
-              "teststeps",
-              "workrecords",
-              "revisions",
-              "testrecord_attachments"
-            ],
-            "type": "string"
-          }
-        },
-        "type": "object"
-      }
-    },
-    "type": "object"
-  },
-  {
-    "properties": {
-      "data": {
-        "items": {
-          "properties": {
-            "id": {
-              "example": "MyProjectId/MyResourceId",
-              "type": "string"
-            },
-            "type": {
-              "enum": [
-                "categories",
-                "documents",
-                "document_attachments",
-                "document_comments",
-                "document_parts",
-                "enumerations",
-                "globalroles",
-                "icons",
-                "jobs",
-                "linkedworkitems",
-                "externallylinkedworkitems",
-                "linkedoslcresources",
-                "pages",
-                "page_attachments",
-                "plans",
-                "projectroles",
-                "projectgroups",
-                "projects",
-                "projecttemplates",
-                "spaces",
-                "testparameters",
-                "testparameter_definitions",
-                "testrecords",
-                "teststep_results",
-                "testruns",
-                "testrun_attachments",
-                "teststepresult_attachments",
-                "testrun_comments",
-                "usergroups",
-                "users",
-                "workitems",
-                "workitem_attachments",
-                "workitem_approvals",
-                "workitem_comments",
-                "featureselections",
-                "teststeps",
-                "workrecords",
-                "revisions",
-                "testrecord_attachments"
-              ],
-              "type": "string"
-            }
-          },
-          "type": "object"
-        },
-        "type": "array"
-      }
-    },
-    "type": "object"
-  }
-]New value: +[
+  {
+    "properties": {
+      "data": {
+        "properties": {
+          "id": {
+            "example": "MyResourceId",
+            "type": "string"
+          },
+          "type": {
+            "enum": [
+              "collections",
+              "categories",
+              "documents",
+              "document_attachments",
+              "document_comments",
+              "document_parts",
+              "enumerations",
+              "globalroles",
+              "icons",
+              "jobs",
+              "linkedworkitems",
+              "externallylinkedworkitems",
+              "linkedoslcresources",
+              "llms",
+              "pages",
+              "page_attachments",
+              "page_comments",
+              "plans",
+              "projectroles",
+              "projectgroups",
+              "projects",
+              "projecttemplates",
+              "spaces",
+              "testparameters",
+              "testparameter_definitions",
+              "testrecords",
+              "teststep_results",
+              "testruns",
+              "testrun_attachments",
+              "teststepresult_attachments",
+              "testrun_comments",
+              "usergroups",
+              "users",
+              "workitems",
+              "workitem_attachments",
+              "workitem_approvals",
+              "workitem_comments",
+              "featureselections",
+              "teststeps",
+              "workrecords",
+              "revisions",
+              "testrecord_attachments",
+              "license_slots",
+              "license_types",
+              "license",
+              "metadata",
+              "license_assignments",
+              "customfields"
+            ],
+            "type": "string"
+          }
+        },
+        "type": "object"
+      }
+    },
+    "type": "object"
+  },
+  {
+    "properties": {
+      "data": {
+        "items": {
+          "properties": {
+            "id": {
+              "example": "MyResourceId",
+              "type": "string"
+            },
+            "type": {
+              "enum": [
+                "collections",
+                "categories",
+                "documents",
+                "document_attachments",
+                "document_comments",
+                "document_parts",
+                "enumerations",
+                "globalroles",
+                "icons",
+                "jobs",
+                "linkedworkitems",
+                "externallylinkedworkitems",
+                "linkedoslcresources",
+                "llms",
+                "pages",
+                "page_attachments",
+                "page_comments",
+                "plans",
+                "projectroles",
+                "projectgroups",
+                "projects",
+                "projecttemplates",
+                "spaces",
+                "testparameters",
+                "testparameter_definitions",
+                "testrecords",
+                "teststep_results",
+                "testruns",
+                "testrun_attachments",
+                "teststepresult_attachments",
+                "testrun_comments",
+                "usergroups",
+                "users",
+                "workitems",
+                "workitem_attachments",
+                "workitem_approvals",
+                "workitem_comments",
+                "featureselections",
+                "teststeps",
+                "workrecords",
+                "revisions",
+                "testrecord_attachments",
+                "license_slots",
+                "license_types",
+                "license",
+                "metadata",
+                "license_assignments",
+                "customfields"
+              ],
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "type": "array"
+      }
+    },
+    "type": "object"
+  }
+]
  5. First observedv1.0.0

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true and idempotentHint=true, but the description goes further by spelling out that the effect is irreversible and that overwritten data cannot be recovered through the API, plus how dry_run previews are returned. That is genuine added context, though it says nothing about what happens to relationships omitted from the list (merge vs replace).

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?

Purpose and the irreversibility warning are front-loaded and each sentence is short. The closing clause about structured content 'when the tool declares an output schema' is boilerplate that does not apply here (no output schema) and adds noise.

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?

The requestBody is a deeply nested oneOf of resource-reference objects, and the description never explains what a relationship payload should contain or whether the list replaces or appends to existing relationships. With no output schema and a destructive write, that semantic gap matters even though the schema documents field structure.

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 only echoes dry_run, which the schema already documents in greater detail, and adds no meaning for projectId, workItemId, relationshipId, or the oneOf requestBody shape.

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?

States a specific verb and resource: 'Updates a list of Work Item Relationships.' However, it never distinguishes itself from the very similar siblings postWorkItemRelationships, getWorkItemsRelationships, deleteWorkItemsRelationship, or patchLinkedWorkItem, so an agent cannot tell PATCH-replace from POST-create without inferring from the tool name.

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?

The 'set dry_run: true first' tip gives procedural guidance for safe invocation, but there is no statement of when this tool applies versus the create/read/delete relationship siblings, and no prerequisites (permissions, project scope) are named. Usage is implied by the tool name rather than explained.

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