Skip to main content
Glama
phillipboesger

Polarion MCP Server

mergeDocumentToMaster

Merge Work Item changes from a branched document into the master document in Polarion, with optional user filter and baseline creation.

Instructions

Merges Work Item changes from specified Branched Document to Master. 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.3/5.0
Behavior5/5

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

The description goes beyond annotations by explaining that the tool 'triggers a server-side action rather than a plain resource creation,' that idempotency is not guaranteed, and that dry_run can preview the request without changing anything. This adds meaningful behavioral context consistent with idempotentHint=false and openWorldHint=true.

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 moderately sized and front-loaded with the core purpose. Every sentence contributes useful information—purpose, side-effect/idempotency caveat, and dry_run guidance—though the idempotency explanation could be slightly tightened.

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 tool's server-side action nature and the existence of an output schema, the description adequately covers side effects, idempotency, and dry_run usage. It does not explicitly route to the opposite-direction sibling, but the schema and directionality provide enough context for correct invocation.

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 adds value by clarifying the dry_run behavior, especially the note that the preview is returned as an error-flagged result even though it is not real tool output. This enriches the schema's dry_run description without repeating all parameter details.

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 uses a specific verb and resource: 'Merges Work Item changes from specified Branched Document to Master.' The directionality clearly distinguishes it from the sibling mergeDocumentFromMaster, so an agent can understand what this tool does without opening the schema.

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 states the operation and its direction, which implies the tool is for moving changes from a branched document to the master. However, it does not explicitly mention when to prefer this tool over mergeDocumentFromMaster or other merge-related alternatives, leaving the selection partly to inference.

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