Polarion MCP Server

postDocumentParts

Adds structured parts to a Polarion LiveDoc and returns the created parts; use dry_run first to validate the request and preview changes.

Instructions

Adds structured parts to a LiveDoc and returns the created parts. Use valid LiveDoc part types and read existing content with getDocumentParts first; use overwriteDocumentParts only when replacing the full structure. Effect: creates a new resource. Repeating this call may create additional resources; it is 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
`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.
`spaceId`	Yes	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.
`projectId`	Yes	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.
`requestBody`	Yes	The Document Part(s) body.
`documentName`	Yes	The Document name.

Output Schema

Name	Required	Description	Default
`data`	No

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedv1.4.4Oct 29, 2026

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

Changed9 schema fields changedv1.3.1Oct 22, 2026

removedOutput schema / properties / data / items / properties / id / example

Removed value: -"MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId"

changedOutput schema / properties / data / items / properties / id / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

removedOutput schema / properties / data / items / properties / links / properties / self / example

Removed value: -"server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts/workitem_MyWorkItemId?revision=1234"

changedOutput schema / properties / data / items / properties / links / properties / self / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / data / items / properties / links / type
```
Previous value: -"object"New value: +[
+  "object",
+  "null"
+]
```
removedOutput schema / properties / data / items / properties / type / enum
```
Removed value: -[
-  "document_parts"
-]
```

changedOutput schema / properties / data / items / properties / type / type

Previous value: -"string"New value: +[
+  "string",
+  "number",
+  "integer",
+  "boolean",
+  "null"
+]

changedOutput schema / properties / data / items / type

Previous value: -"object"New value: +[
+  "object",
+  "null"
+]

changedOutput schema / properties / data / type

Previous value: -"array"New value: +[
+  "array",
+  "null"
+]

Changed3 schema fields 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."

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

Changed1 schema field changedv1.1.0Sep 11, 2026

changedOutput schema / (root)

Previous value: -nullNew value: +{
+  "properties": {
+    "data": {
+      "items": {
+        "properties": {
+          "id": {
+            "example": "MyProjectId/MySpaceId/MyDocumentId/workitem_MyWorkItemId",
+            "type": "string"
+          },
+          "links": {
+            "properties": {
+              "self": {
+                "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/parts/workitem_MyWorkItemId?revision=1234",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": {
+            "enum": [
+              "document_parts"
+            ],
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}

Changed9 schema fields 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"
+}

addedInput schema / properties / requestBody / properties / data / items / properties / attributes / properties / content
```
Added value: +{
+  "description": "Editable only for normal and table document parts.",
+  "type": "string"
+}
```
addedInput schema / properties / requestBody / properties / data / items / properties / attributes / properties / headingText
```
Added value: +{
+  "description": "Applicable to: heading parts.",
+  "type": "string"
+}
```

addedInput schema / properties / requestBody / properties / data / items / properties / attributes / properties / landscape

Added value: +{
+  "description": "Whether the page break switches to landscape orientation. Applicable to: pagebreak parts.",
+  "type": "boolean"
+}

addedInput schema / properties / requestBody / properties / data / items / properties / attributes / properties / layout

Added value: +{
+  "description": "Rendering layout index for the part. Applicable to: workitem parts.",
+  "format": "int32",
+  "type": "number"
+}

addedInput schema / properties / requestBody / properties / data / items / properties / attributes / properties / level / description
```
Added value: +"Outline level/depth of the part in the document hierarchy. Applicable to: heading, workitem parts."
```

addedInput schema / properties / requestBody / properties / data / items / properties / attributes / properties / sequence

Added value: +{
+  "description": "Sequence identifier for table of figures entry. Applicable to: tof parts.",
+  "type": "string"
+}

addedInput schema / properties / requestBody / properties / data / items / properties / attributes / properties / type / description
```
Added value: +"Possible values: heading, normal, pagebreak, table, toc, tof, wikiblock, workitem. Required for creation."
```

addedInput schema / properties / requestBody / properties / data / items / properties / attributes / properties / wikiText

Added value: +{
+  "description": "Wiki markup content for the block. Applicable to: wikiblock parts.",
+  "type": "string"
+}

First observedv1.0.0Jun 13, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false and openWorldHint=true, but the description adds the practical consequence: repeating the call may create additional resources. The dry_run explanation (Authorization redacted, binary payloads summarized by byte length, preview returned as text or structured content) is genuinely beyond the annotations, though the idempotency sentence largely restates the hint.

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?

Front-loaded with the action and return value, then alternatives, then behavior. The dry_run/executor-output sentences are the longest block and edge toward verbose, but each carries actionable information.

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?

An output schema exists so return values need no explanation, and the description covers side effects, sibling routing, and validation strategy for a nested-body mutation tool. What remains unaddressed is minor (e.g., ordering/relationship semantics of parts), which the schema carries.

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 all five parameters including the deeply nested requestBody attributes are already documented in the schema. The description only adds a generic constraint ("use valid LiveDoc part types") and the dry_run tip, which the schema also explains. Baseline 3 is appropriate.

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 ("Adds structured parts to a LiveDoc") plus the return behavior ("returns the created parts"). It explicitly names the siblings it is not (getDocumentParts, overwriteDocumentParts), so an agent can distinguish it without opening any schema.

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?

Gives explicit routing: read existing content with `getDocumentParts` first, and use `overwriteDocumentParts` only when replacing the full structure. It also names a concrete precondition (valid LiveDoc part types) and a recommended validation step (dry_run first).

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

Deploy Server