Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

patchPlanRelationships

Idempotent

Update a list of plan relationships in Polarion. Preview the request first with dry-run to validate changes without applying them.

Instructions

Updates a list of Plan Relationships. Effect: idempotent — calling it again with the same input leaves the resource in the same end state, with no additional side effects. Tip: set dry_run: true first to preview the exact request Polarion would receive, without changing anything. On tools with a typed output schema, this preview is returned as an error-flagged result since it is not real tool output -- read the text content regardless of that flag.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
planIdYesThe Plan ID.
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; call getProjects to list valid IDs.
requestBodyYesThe Work Item(s) 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.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."
  2. Changed3 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."
  3. 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"
+  }
+]
  4. First observedv1.0.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare idempotentHint: true and destructiveHint: false, but the description adds behavioral nuance by explicitly stating the idempotent effect and describing the dry_run preview behavior, including how the preview is returned as an error-flagged result. This goes beyond the annotations and provides essential operational context.

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 highly concise, conveying the main action and two crucial behavioral notes in two sentences. It front-loads the purpose and immediately clarifies idempotency, then provides the dry_run tip. No superfluous information is present, and the structure is easy to scan.

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?

Given the tool has no output schema, the description does not explain the normal return value (likely the updated resource). It does cover the dry_run preview case, but an agent calling this in a non-dry-run mode would not know what to expect back. The complex requestBody structure is documented in the schema, so that gap is acceptable. Overall, the description is adequate but lacks clarity on the standard response format.

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 schema already documents all parameters. The description does not add extra meaning beyond the schema for parameters like projectId, planId, relationshipId, or requestBody. It only reinforces the dry_run parameter already documented, offering no additional semantic enrichment. Baseline 3 is appropriate.

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 states a precise action ('Updates a list of Plan Relationships') with a clear resource target. It also distinguishes from sibling operations like postPlanRelationships (create) and deletePlanRelationship (delete) by specifying the update/patch semantics, so an agent can confidently select it.

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 description does not explicitly state when to use this tool versus alternatives (e.g., 'use for existing plan relationships, not for creation'). However, it provides a valuable usage tip about dry_run and how to interpret the preview result, which helps the agent use the tool correctly. The 'updates' verbiage implies replacing create/delete, but no explicit alternative routing is given.

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