Skip to main content
Glama
Sign In
Polarion MCP Server

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

postPlanRelationships

Add relationship links to one Polarion Plan while preserving existing links; use dry_run to validate and preview the exact request before sending.

Instructions

Adds relationship links to one Plan while retaining existing links. Provide JSON:API linkage; use getPlanRelationship to inspect the set or patchPlanRelationships 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
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. If the ID is unknown, ask the user; getProjects lists IDs only with global read access.
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.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. 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."
  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.3/5.0
Behavior4/5

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

The description adds useful behavioral context beyond the annotations: it says existing links are retained, the effect creates a new resource, repeated calls may create additional resources, and dry_run previews the exact request. It does not describe the actual success response or permission requirements, but with annotations already covering read-only, destructive, idempotency, and open-world hints, this is a strong disclosure.

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?

The description is front-loaded with the core operation and alternative tools, then adds effect, idempotency, and dry_run guidance. It is efficient overall, though the final sentence about structured content is somewhat incidental when no output schema exists.

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?

For a non-idempotent mutation with a complex nested requestBody and no output schema, the description gives the essential context: retention behavior, created-resource effect, non-idempotency warning, and dry_run validation. It could be stronger by noting permissions or actual mutation return behavior, but the annotations and rich schema cover much of the rest.

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 five parameters, including the complex requestBody and relationshipId. The description adds only the high-level instruction to provide JSON:API linkage and does not add syntax beyond the schema, so the baseline of 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 specific verb and resource: it adds relationship links to one Plan while retaining existing links. It also explicitly distinguishes this tool from getPlanRelationship (inspect) and patchPlanRelationships (replace), so an agent can identify its purpose without opening sibling schemas.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It clearly states the use case for adding links without replacing the existing set, names the alternatives for inspecting or replacing the relationship set, and recommends dry_run to validate before sending. The when-to-use and when-to-use-a-sibling guidance is explicit.

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