Skip to main content
Glama
phillipboesger

Polarion MCP Server

mergeDocumentFromMaster

Merge Master Work Item changes into a specified branched document in Polarion, with optional baseline creation and a dry-run mode to preview the request before applying it.

Instructions

Merges Master Work Item changes to the specified Branched 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.
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.
requestBodyNoMerge Document parameters.
documentNameYesThe Branch Document Name.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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 / 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": {
      +            "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"
      +}
  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

A4.2/5.0
Behavior5/5

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

The description goes well beyond the annotations by explaining this is a server-side action, not a plain resource creation, and that it is not guaranteed idempotent. It also discloses how dry_run results are returned as error-flagged output, which is important behavioral context an agent could not infer from annotations alone.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact, with the core action stated first, followed by essential behavioral caveats and a practical tip. Every sentence contributes useful information without fluff or repetition.

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?

The description covers the action, side-effect profile, idempotency concern, dry_run workflow, and how to interpret preview results. With an output schema present, return-value details are already covered. It would be more complete with explicit guidance about when to use this versus the sibling mergeDocumentToMaster, but it is otherwise sufficient for safe invocation.

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. The description reinforces the dry_run behavior but does not add substantial new meaning to individual parameters; the baseline of 3 is appropriate since the schema carries the parameter-semantics burden.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific action ('Merges Master Work Item changes to the specified Branched Document') with a clear verb and resource. It also makes the direction explicit ('from Master' to branched document), which distinguishes it from the sibling mergeDocumentToMaster without requiring schema inspection.

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?

The description includes a clear tip to use dry_run first and warns about idempotency, but it does not explicitly state when to choose this tool over alternatives such as mergeDocumentToMaster or branchDocuments. Usage context is implied by the action and direction, but no explicit exclusions or alternative-conditions are provided.

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