Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

postPlanRelationships

Create relationships on a Polarion plan by specifying the project, plan, relationship name, and work item body. Use dry run first to preview the exact request and avoid creating duplicate resources.

Instructions

Creates the specific Relationships for the Plan. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not idempotent. 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.8/5.0
Behavior5/5

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

The description goes well beyond the annotations (idempotentHint=false, readOnlyHint=false) by disclosing the concrete behavioral consequence: 'creates a new resource on each call — calling it again with the same input creates a duplicate.' It also fully explains the dry_run semantics (previews without changing anything) and the counter-intuitive error-flagged preview result. No contradiction with annotations; this is exactly the kind of side-effect transparency the rubric rewards.

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 purpose, and each subsequent sentence adds a distinct behavioral fact: non-idempotency, dry_run workflow, and the error-flag caveat. It is slightly verbose — the final sentence about 'tools with a typed output schema' is a generic caveat that does not apply to this tool since it has no output schema, and the em-dash phrasing slows scanning.

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?

For a 5-parameter tool with nested oneOf structures and no output schema, the description covers the critical behavioral risks well (duplication, dry_run). However, it omits expected return value or success indication, and it never routes the agent away from closely related siblings like postWorkItemRelationships when deciding which resource should own the relationship. Adequate but with notable gaps.

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 thoroughly, including the nested requestBody oneOf structure and dry_run behavior. The description adds only marginal value — mainly the recommendation to set dry_run first, which mostly restates the schema. Baseline 3 is appropriate since schema carries the burden.

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?

The description states a specific verb and resource — 'Creates the specific Relationships for the Plan' — which clearly identifies the operation and target resource. It implicitly differentiates from siblings like postPageRelationships and postCollectionsRelationships by naming the Plan, though it does not explicitly name any alternative. The phrase 'specific Relationships' is slightly vague on its own, but the schema's relationshipId description (e.g. assignee, linkedWorkItems) resolves 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?

Usage is implied — an agent can infer this tool is for creating relationships on a Plan — but there is no explicit when-to-use vs. alternatives guidance. The description never distinguishes it from patchPlanRelationships or postWorkItemRelationships, which is a real ambiguity since both can touch plan-related relationships. The dry_run tip is valuable operational guidance, but it addresses safe invocation rather than tool selection.

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