Skip to main content
Glama
Sign In
Polarion MCP Server

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

postWorkItemRelationships

Add relationship links to a Polarion Work Item while preserving existing links; use dry-run validation to preview the exact request before creating new resources.

Instructions

Adds relationship linkage to one Work Item while preserving existing relationships. Provide JSON:API linkage; inspect it with getWorkItemsRelationships or use patchWorkItemRelationships to replace it. Effect: creates a new resource. Repeating this call may create additional resources; it is not guaranteed idempotent. 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

A4.1/5.0
Behavior4/5

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

Adds real context beyond annotations: existing relationships are preserved, the call creates a new resource, and repeats may create duplicates (reinforcing idempotentHint=false with a concrete consequence). The dry_run tip plus the explanation that the Authorization header is redacted and binary payloads summarized is useful preview behavior. Minor redundancy with the annotation hints keeps it from a 5.

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?

Front-loaded with purpose and scope, then effect, then the dry_run tip. The final sentence about the executor returning the preview 'as structured content when the tool declares an output schema' is generic harness boilerplate that does not help an agent decide or invoke, which costs it a point.

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?

No output schema exists, yet the description explains what a dry_run returns (validated preview with redactions) and that the real call creates a resource. Combined with 100% schema coverage, an agent has nearly everything needed; only the success-response shape of the non-dry-run path is unstated.

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%, and the schema already explains projectId, workItemId, relationshipId and dry_run thoroughly. The description adds only the framing 'provide JSON:API linkage' for requestBody, which the schema's oneOf structure already implies. 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?

States a specific verb+resource ('Adds relationship linkage to one Work Item') and an important scope constraint ('while preserving existing relationships'). It also names the two sibling tools that operate on the same resource (getWorkItemsRelationships, patchWorkItemRelationships) and how they differ, so an agent can distinguish it without opening the schema.

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?

Explicitly routes the agent: inspect with getWorkItemsRelationships, replace with patchWorkItemRelationships, and recommends a dry_run validation first. It gives clear context and alternatives but does not state explicit exclusions (e.g. when not to add a relationship, or how this differs from postLinkedWorkItems).

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