Skip to main content
Glama
Sign In
Polarion MCP Server

Polarion MCP Server

by phillipboesger
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Hybrid

branchDocument

Creates a branched LiveDoc from a source document, optionally into another project or space, and returns an asynchronous job to poll for completion.

Instructions

Creates a branched LiveDoc and returns an asynchronous jobs resource. requestBody.documentConfigurations identifies the source and optional target project, space, and document name; omit target project/space to branch within the source project and space. Requires read access to the source and write access to the target; poll getJob for completion. Use copyDocument when branch lineage is not needed. 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

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. If the ID is unknown, ask the user; getProjects lists IDs only with global read access.
requestBodyYesBranching parameters.
documentNameYesThe Document name.

Output Schema

NameRequiredDescriptionDefault
dataNo

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. Changed114 schema fields changedv1.3.1
    • changedOutput schema / properties / data / properties / attributes / properties / autoSuspect / type
      Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / branchedWithInitializedFields / items / example
      Removed value: -"fieldId"
    • changedOutput schema / properties / data / properties / attributes / properties / branchedWithInitializedFields / items / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / properties / branchedWithInitializedFields / type
      Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / branchedWithQuery / example
      Removed value: -"Branched with Query"
    • changedOutput schema / properties / data / properties / attributes / properties / branchedWithQuery / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / created / example
      Removed value: -"1970-01-01T00:00:00Z"
    • removedOutput schema / properties / data / properties / attributes / properties / created / format
      Removed value: -"date-time"
    • changedOutput schema / properties / data / properties / attributes / properties / created / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / derivedFields / items / example
      Removed value: -"fieldId"
    • changedOutput schema / properties / data / properties / attributes / properties / derivedFields / items / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / properties / derivedFields / type
      Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / derivedFromLinkRole / example
      Removed value: -"relates_to"
    • changedOutput schema / properties / data / properties / attributes / properties / derivedFromLinkRole / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / homePageContent / properties / type / enum
      Removed value: -[
-  "text/html",
-  "text/plain"
-]
    • changedOutput schema / properties / data / properties / attributes / properties / homePageContent / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / homePageContent / properties / value / example
      Removed value: -"My text value"
    • changedOutput schema / properties / data / properties / attributes / properties / homePageContent / properties / value / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / properties / homePageContent / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / moduleFolder / example
      Removed value: -"MySpaceId"
    • changedOutput schema / properties / data / properties / attributes / properties / moduleFolder / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / outlineNumbering / properties / prefix / example
      Removed value: -"ABC"
    • changedOutput schema / properties / data / properties / attributes / properties / outlineNumbering / properties / prefix / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / properties / outlineNumbering / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / label / example
      Removed value: -"My label"
    • changedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / label / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / layouter / example
      Removed value: -"paragraph"
    • changedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / layouter / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / properties / items / properties / key / example
      Removed value: -"fieldsAtStart"
    • changedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / properties / items / properties / key / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / properties / items / properties / value / example
      Removed value: -"id"
    • changedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / properties / items / properties / value / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / properties / items / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / properties / type
      Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / type / example
      Removed value: -"task"
    • changedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / items / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / properties / renderingLayouts / type
      Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / status / example
      Removed value: -"draft"
    • changedOutput schema / properties / data / properties / attributes / properties / status / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / title / example
      Removed value: -"Title"
    • changedOutput schema / properties / data / properties / attributes / properties / title / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / type / example
      Removed value: -"req_specification"
    • changedOutput schema / properties / data / properties / attributes / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / attributes / properties / updated / example
      Removed value: -"1970-01-01T00:00:00Z"
    • removedOutput schema / properties / data / properties / attributes / properties / updated / format
      Removed value: -"date-time"
    • changedOutput schema / properties / data / properties / attributes / properties / updated / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / properties / usesOutlineNumbering / type
      Previous value: -"boolean"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / attributes / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / properties / id / example
      Removed value: -"MyProjectId/MySpaceId/MyDocumentId"
    • changedOutput schema / properties / data / properties / id / 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/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId?revision=1234"
    • 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 / attachments / properties / data / items / properties / id / example
      Removed value: -"MyProjectId/MySpaceId/MyDocumentId/MyAttachmentId"
    • changedOutput schema / properties / data / properties / relationships / properties / attachments / properties / data / items / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / attachments / properties / data / items / properties / type / enum
      Removed value: -[
-  "document_attachments"
-]
    • changedOutput schema / properties / data / properties / relationships / properties / attachments / properties / data / items / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / attachments / properties / data / items / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / attachments / properties / data / type
      Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / attachments / properties / links / properties / related / example
      Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/attachments?revision=1234"
    • changedOutput schema / properties / data / properties / relationships / properties / attachments / properties / links / properties / related / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / attachments / properties / links / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / attachments / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / author / properties / data / properties / id / example
      Removed value: -"MyUserId"
    • changedOutput schema / properties / data / properties / relationships / properties / author / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / author / properties / data / properties / type / enum
      Removed value: -[
-  "users"
-]
    • changedOutput schema / properties / data / properties / relationships / properties / author / properties / data / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / author / properties / data / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / author / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / branchedFrom / properties / data / properties / id / example
      Removed value: -"MyProjectId/MySpaceId/MyDocumentId"
    • changedOutput schema / properties / data / properties / relationships / properties / branchedFrom / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / branchedFrom / properties / data / properties / type / enum
      Removed value: -[
-  "documents"
-]
    • changedOutput schema / properties / data / properties / relationships / properties / branchedFrom / properties / data / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / branchedFrom / properties / data / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / branchedFrom / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / comments / properties / data / items / properties / id / example
      Removed value: -"MyProjectId/MySpaceId/MyDocumentId/MyCommentId"
    • changedOutput schema / properties / data / properties / relationships / properties / comments / properties / data / items / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / comments / properties / data / items / properties / type / enum
      Removed value: -[
-  "document_comments"
-]
    • changedOutput schema / properties / data / properties / relationships / properties / comments / properties / data / items / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / comments / properties / data / items / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / comments / properties / data / type
      Previous value: -"array"New value: +[
+  "array",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / comments / properties / links / properties / related / example
      Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments?revision=1234"
    • changedOutput schema / properties / data / properties / relationships / properties / comments / properties / links / properties / related / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / comments / properties / links / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / comments / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / derivedFrom / properties / data / properties / id / example
      Removed value: -"MyProjectId/MySpaceId/MyDocumentId"
    • changedOutput schema / properties / data / properties / relationships / properties / derivedFrom / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / derivedFrom / properties / data / properties / type / enum
      Removed value: -[
-  "documents"
-]
    • changedOutput schema / properties / data / properties / relationships / properties / derivedFrom / properties / data / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / derivedFrom / properties / data / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / derivedFrom / 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"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / updatedBy / properties / data / properties / id / example
      Removed value: -"MyUserId"
    • changedOutput schema / properties / data / properties / relationships / properties / updatedBy / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / updatedBy / properties / data / properties / type / enum
      Removed value: -[
-  "users"
-]
    • changedOutput schema / properties / data / properties / relationships / properties / updatedBy / properties / data / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / updatedBy / properties / data / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / updatedBy / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / variant / properties / data / properties / id / example
      Removed value: -"MyProjectId/MyWorkItemId"
    • changedOutput schema / properties / data / properties / relationships / properties / variant / properties / data / properties / id / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • removedOutput schema / properties / data / properties / relationships / properties / variant / properties / data / properties / type / enum
      Removed value: -[
-  "workitems"
-]
    • changedOutput schema / properties / data / properties / relationships / properties / variant / properties / data / properties / type / type
      Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / variant / properties / data / type
      Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
    • changedOutput schema / properties / data / properties / relationships / properties / variant / 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: -[
-  "documents"
-]
    • 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"
+]
  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 / 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."
  4. 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"
+}
  5. 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"
+}
  6. First observedv1.0.0

TDQS

A4.3/5.0
Behavior5/5

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

Beyond the annotations, the description explains that the tool returns an asynchronous jobs resource, requires read/write access, triggers a server-side action, and is not guaranteed idempotent. It also recommends `dry_run: true` for validation, which is useful behavioral context for a non-readOnly mutation.

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 definition is front-loaded with the core purpose and async behavior, then moves to prerequisites and alternatives. It is dense but mostly earns its length, though the closing note about executor preview formatting is somewhat meta and less useful at invocation time.

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 output schema and rich annotations, the description covers the async workflow, permissions, alternative tool, and dry-run validation well. The main gap is the mismatched `requestBody.documentConfigurations` reference and the missing singular-vs-plural distinction from `branchDocuments`.

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 coverage is 100%, so the schema already documents all six parameters. The description adds some useful semantics about omitting target project/space to branch within the source, but it refers to `requestBody.documentConfigurations`, which does not match the input schema's direct `requestBody` properties. That inconsistency limits the added clarity.

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 a branched LiveDoc and returns an asynchronous `jobs` resource. It distinguishes itself from `copyDocument`, but it does not distinguish itself from the sibling `branchDocuments` plural tool, which is an important ambiguity given the near-identical name.

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 explicitly states when to use `copyDocument` instead ('when branch lineage is not needed'), gives access prerequisites, and directs the agent to poll `getJob` for completion. This is clear guidance with an explicit alternative.

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