Skip to main content
Glama
phillipboesger

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

branchDocument

Create a branch of a Polarion document in a target project or space, with optional workflow status and signature copying. Use dry_run to preview the exact request before applying.

Instructions

Creates a Branch of the 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 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
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.
spaceIdYesThe Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space.
revisionNoA specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision.
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.
requestBodyYesBranching parameters.
documentNameYesThe Document name.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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 / revision / description
      Previous value: -"The revision ID."New value: +"A specific repository revision (e.g. `1234`) to read the resource as it existed at that revision instead of the current HEAD. Omit to use the latest revision."
    • changedInput schema / properties / spaceId / description
      Previous value: -"The Space ID. (Use '_default' without quotes to address the default Space.)"New value: +"The Document Space ID (a folder-like grouping of documents/pages within a project). Use `_default` (no quotes) to address the project's default space."
  2. Changed1 schema field changedv1.1.0
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "properties": {
+        "attributes": {
+          "properties": {
+            "autoSuspect": {
+              "type": "boolean"
+            },
+            "branchedWithInitializedFields": {
+              "items": {
+                "example": "fieldId",
+                "type": "string"
+              },
+              "type": "array"
+            },
+            "branchedWithQuery": {
+              "example": "Branched with Query",
+              "type": "string"
+            },
+            "created": {
+              "example": "1970-01-01T00:00:00Z",
+              "format": "date-time",
+              "type": "string"
+            },
+            "derivedFields": {
+              "items": {
+                "example": "fieldId",
+                "type": "string"
+              },
+              "type": "array"
+            },
+            "derivedFromLinkRole": {
+              "example": "relates_to",
+              "type": "string"
+            },
+            "homePageContent": {
+              "properties": {
+                "type": {
+                  "enum": [
+                    "text/html",
+                    "text/plain"
+                  ],
+                  "type": "string"
+                },
+                "value": {
+                  "example": "My text value",
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            },
+            "moduleFolder": {
+              "example": "MySpaceId",
+              "type": "string"
+            },
+            "outlineNumbering": {
+              "properties": {
+                "prefix": {
+                  "example": "ABC",
+                  "type": "string"
+                }
+              },
+              "type": "object"
+            },
+            "renderingLayouts": {
+              "items": {
+                "properties": {
+                  "label": {
+                    "example": "My label",
+                    "type": "string"
+                  },
+                  "layouter": {
+                    "example": "paragraph",
+                    "type": "string"
+                  },
+                  "properties": {
+                    "items": {
+                      "properties": {
+                        "key": {
+                          "example": "fieldsAtStart",
+                          "type": "string"
+                        },
+                        "value": {
+                          "example": "id",
+                          "type": "string"
+                        }
+                      },
+                      "type": "object"
+                    },
+                    "type": "array"
+                  },
+                  "type": {
+                    "example": "task",
+                    "type": "string"
+                  }
+                },
+                "type": "object"
+              },
+              "type": "array"
+            },
+            "status": {
+              "example": "draft",
+              "type": "string"
+            },
+            "title": {
+              "example": "Title",
+              "type": "string"
+            },
+            "type": {
+              "example": "req_specification",
+              "type": "string"
+            },
+            "updated": {
+              "example": "1970-01-01T00:00:00Z",
+              "format": "date-time",
+              "type": "string"
+            },
+            "usesOutlineNumbering": {
+              "type": "boolean"
+            }
+          },
+          "type": "object"
+        },
+        "id": {
+          "example": "MyProjectId/MySpaceId/MyDocumentId",
+          "type": "string"
+        },
+        "links": {
+          "properties": {
+            "self": {
+              "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234",
+              "type": "string"
+            }
+          },
+          "type": "object"
+        },
+        "relationships": {
+          "properties": {
+            "attachments": {
+              "properties": {
+                "data": {
+                  "items": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "document_attachments"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "type": "array"
+                },
+                "links": {
+                  "properties": {
+                    "related": {
+                      "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234",
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "author": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyUserId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "users"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "branchedFrom": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyProjectId/MySpaceId/MyDocumentId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "documents"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "comments": {
+              "properties": {
+                "data": {
+                  "items": {
+                    "properties": {
+                      "id": {
+                        "example": "MyProjectId/MySpaceId/MyDocumentId/MyCommentId",
+                        "type": "string"
+                      },
+                      "type": {
+                        "enum": [
+                          "document_comments"
+                        ],
+                        "type": "string"
+                      }
+                    },
+                    "type": "object"
+                  },
+                  "type": "array"
+                },
+                "links": {
+                  "properties": {
+                    "related": {
+                      "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234",
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "derivedFrom": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyProjectId/MySpaceId/MyDocumentId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "documents"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "project": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyProjectId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "projects"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "updatedBy": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyUserId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "users"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            },
+            "variant": {
+              "properties": {
+                "data": {
+                  "properties": {
+                    "id": {
+                      "example": "MyProjectId/MyWorkItemId",
+                      "type": "string"
+                    },
+                    "type": {
+                      "enum": [
+                        "workitems"
+                      ],
+                      "type": "string"
+                    }
+                  },
+                  "type": "object"
+                }
+              },
+              "type": "object"
+            }
+          },
+          "type": "object"
+        },
+        "type": {
+          "enum": [
+            "documents"
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  3. Changed1 schema field 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"
+}
  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?

The description adds valuable behavioral detail beyond the annotations by explaining the server-side nature, the variable repeatability of the operation, and the dry_run preview behavior including the error-flagged result. This does not contradict the annotations; it reinforces and elaborates on idempotentHint=false while adding context about how preview responses are represented.

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 purpose and keeps the additional caveats in two follow-up sentences. All sentences carry useful information, but the third sentence is somewhat dense and mixes preview mechanics with output-schema behavior, so it is concise but not maximally streamlined.

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?

Given the nested schema and existence of an output schema, the description is largely complete: it covers the important non-idempotency warning, the server-side action nature, and the dry_run safety mechanism. It could be more complete by explicitly contrasting with related sibling operations, but nothing critical needed to call the tool correctly is missing.

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 including nested requestBody fields. The description mentions dry_run usage but mostly repeats what the schema already says; it adds the error-flag nuance but does not provide additional meaning for the other parameters.

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 opens with a specific verb and resource: 'Creates a Branch of the Document.' It clearly identifies what the tool does and adds the meaningful distinction that this is a server-side action rather than a plain resource creation. However, it does not differentiate itself from the sibling tool branchDocuments, so the purpose is clear but not fully distinguished from similar operations.

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?

The description gives actionable guidance: it warns that the action is not guaranteed idempotent and advises setting dry_run=true to preview the exact request before making changes. This is clear context for how to use the tool safely, though it does not explicitly discuss when to choose this over alternatives such as branchDocuments or copyDocument.

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