Polarion MCP Server

branchDocuments

Creates branches for multiple Polarion LiveDocs from specified sources and optional targets, returning asynchronous jobs to poll for completion.

Instructions

Creates branches for multiple source LiveDocs and returns an asynchronous jobs resource. Each documentConfigurations entry supplies a source and may specify its own target; omitted targets stay with the source location. Requires source read and target write permissions; poll getJob for completion. Use branchDocument for one document. Effect: triggers a server-side action rather than a plain resource creation — whether repeating it is safe, a no-op, or rejected depends on the specific action; treat it as 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

Name	Required	Description	Default
`dry_run`	No	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.
`requestBody`	Yes	Branching parameters.

Output Schema

Name	Required	Description	Default
`data`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed45 schema fields changedv1.3.1Oct 22, 2026
- removedOutput schema / properties / data / properties / attributes / properties / jobId / example
```
Removed value: -"example"
```
- changedOutput schema / properties / data / properties / attributes / properties / jobId / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / name / example
```
Removed value: -"example"
```
- changedOutput schema / properties / data / properties / attributes / properties / name / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / state / example
```
Removed value: -"example"
```
- changedOutput schema / properties / data / properties / attributes / properties / state / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / status / properties / message / example
```
Removed value: -"message"
```
- changedOutput schema / properties / data / properties / attributes / properties / status / properties / message / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / attributes / properties / status / properties / type / enum
```
Removed value: -[
-  "OK",
-  "CANCELLED",
-  "FAILED",
-  "UNKNOWN"
-]
```
- changedOutput schema / properties / data / properties / attributes / properties / status / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / properties / status / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / attributes / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / id / example
```
Removed value: -"MyJobId"
```
- changedOutput schema / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / links / properties / downloads / example
```
Removed value: -[
-  "https://example.com/polarion/download/filename1",
-  "https://example.com/polarion/download/filename2"
-]
```
- changedOutput schema / properties / data / properties / links / properties / downloads / items / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / links / properties / downloads / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / links / properties / log / example
```
Removed value: -"server-host-name/application-path/polarion/job-report?jobId=MyJobId"
```
- changedOutput schema / properties / data / properties / links / properties / log / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / links / properties / self / example
```
Removed value: -"server-host-name/application-path/jobs/MyJobId"
```
- changedOutput schema / properties / data / properties / links / properties / self / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / links / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / document / properties / data / properties / id / example
```
Removed value: -"MyProjectId/MySpaceId/MyDocumentId"
```
- changedOutput schema / properties / data / properties / relationships / properties / document / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / document / properties / data / properties / type / enum
```
Removed value: -[
-  "documents"
-]
```
- changedOutput schema / properties / data / properties / relationships / properties / document / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / document / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / document / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / items / properties / id / example
```
Removed value: -"MyProjectId/MySpaceId/MyDocumentId"
```
- changedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / items / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / items / properties / type / enum
```
Removed value: -[
-  "documents"
-]
```
- changedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / items / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / items / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / documents / properties / data / type
```
Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / documents / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / project / properties / data / properties / id / example
```
Removed value: -"MyProjectId"
```
- changedOutput schema / properties / data / properties / relationships / properties / project / properties / data / properties / id / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / relationships / properties / project / properties / data / properties / type / enum
```
Removed value: -[
-  "projects"
-]
```
- changedOutput schema / properties / data / properties / relationships / properties / project / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / project / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / properties / project / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- changedOutput schema / properties / data / properties / relationships / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
- removedOutput schema / properties / data / properties / type / enum
```
Removed value: -[
-  "jobs"
-]
```
- changedOutput schema / properties / data / properties / type / type
```
Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
```
- changedOutput schema / properties / data / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```

Changed1 schema field changedv1.2.0Sep 17, 2026

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."

Changed1 schema field changedv1.1.0Sep 11, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "properties": {
+        "attributes": {
+          "properties": {
+            "jobId": {
+              "example": "example",
+              "type": "string"
+            },
+            "name": {
+              "example": "example",
+              "type": "string"
+            },
+            "state": {
+              "example": "example",
+              "type": "string"
+            },
+            "status": {
+              "properties": {
+                "message": {
+                  "example": "message",
+                  "type": "string"
+                },
+                "type": {
+                  "enum": [
+                    "OK",
+                    "CANCELLED",
+                    "FAILED",
+                    "UNKNOWN"
+                  ],
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "id": {
+          "example": "MyJobId",
+          "type": "string"
+        },
+        "links": {
+          "properties": {
+            "downloads": {
+              "example": [
+                "https://example.com/polarion/download/filename1",
+                "https://example.com/polarion/download/filename2"
+              ],
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            },
+            "log": {
+              "example": "server-host-name/application-path/polarion/job-report?jobId=MyJobId",
+              "type": "string"
+            },
+            "self": {
+              "example": "server-host-name/application-path/jobs/MyJobId",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "relationships": {
+          "properties": {
+            "document": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyProjectId/MySpaceId/MyDocumentId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "documents"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "documents": {
+              "properties": {
+                "data": {
+                  "items": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MySpaceId/MyDocumentId",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "documents"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "type": "array"
+                }
+              },
+              "type": "object"
+            },
+            "project": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyProjectId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "projects"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "type": {
+          "enum": [
+            "jobs"
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}

Changed1 schema field changedSep 7, 2026

addedInput schema / properties / dry_run

Added value: +{
+  "description": "If true, validate and return the request that would be sent without calling Polarion.",
+  "type": "boolean"
+}

First observedv1.0.0Jun 13, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Annotations already declare readOnlyHint=false and idempotentHint=false, but the description adds the async job model, the required permission pair, the polling target, and a nuanced retry warning ("whether repeating it is safe, a no-op, or rejected depends on the specific action"). It also explains that dry_run returns a preview rather than executing — context no annotation provides.

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 sibling alternative are front-loaded, and most sentences carry distinct information. The closing two sentences about how the executor surfaces the dry_run preview (plain text vs. structured content when an output schema is declared) are tooling meta-detail that adds length without helping an agent choose or call the tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, the description needn't document return values, and it still covers the async `jobs` handle and polling path. Combined with full schema coverage and annotations, an agent has everything needed: permissions, defaults for omitted targets, retry posture, and the single-document alternative.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3; the description earns a bump by explaining the semantics of the nested `documentConfigurations` array — each entry supplies a source, may supply its own target, and "omitted targets stay with the source location." That default behavior is not stated in the schema's per-field descriptions.

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 and resource with scope: "Creates branches for multiple source LiveDocs and returns an asynchronous `jobs` resource." The plurality and the async job return are called out immediately, which is exactly what separates it from the singular `branchDocument` sibling.

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?

Names the alternative explicitly ("Use `branchDocument` for one document"), states prerequisites (source read and target write permissions), and gives the follow-up workflow ("poll `getJob` for completion") plus a recommended dry_run-first procedure. When-to-use, when-not-to-use, and the next step are all present.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server