Polarion MCP Server

postDocumentParts

Create multiple document parts in a Polarion document to add headings, tables, work items, and other structural elements.

Instructions

Creates a list of Document Parts. Effect: creates a new resource on each call — calling it again with the same input creates a duplicate; it is not 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

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; call getProjects to list valid IDs.
`requestBody`	Yes	The Document Part(s) body.
`documentName`	Yes	The Document name.

Output Schema

TableJSON Schema

Name	Required	Description	Default
`data`	No

Schema Changelog

Changes observed during successful MCP inspections.

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.1/5.0

Behavior5/5

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

The description explicitly discloses that each call creates a new resource and is not idempotent – reinforcing and extending the idempotentHint=false annotation. It also reveals a subtle behavioral trait: the dry_run preview returns an error-flagged result on typed output schema, and instructs to read text content regardless. These details are not present in annotations and materially help the agent handle outcomes correctly.

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 two sentences, front-loaded with the core purpose, then a crucial behavioral warning, then a practical tip. Every clause earns its place – no fluff. The dry_run tip is concise and actionable. This is a model of efficient, well-ordered tool documentation.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is complex (nested objects, 5 parameters, output schema), but the description covers the non-obvious aspects: non-idempotency, duplicate creation, and the dry_run preview behavior. The schema and output schema handle parameter and return details, and annotations cover safety flags. The description fills the gaps that structured data cannot, making it complete for correct 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%, with detailed descriptions for every parameter including nested ones like requestBody attributes and relationships. The description adds only a tip about dry_run, but the schema already fully explains dry_run's behavior. Thus the description provides little beyond what the schema offers; the baseline of 3 is appropriate since the schema carries the semantic load.

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 clearly states 'Creates a list of Document Parts' – a specific verb and resource. It distinguishes from sibling tools like getDocumentParts (retrieve), deleteDocumentParts (delete), and patchDocumentParts (modify) by focusing on creation. The added note about non-idempotency further clarifies the operation's side effect, making the purpose unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no explicit guidance on when to choose this tool over alternatives such as postDocuments, postPages, or postDocumentComments. It mentions the dry_run tip but that is about invocation practice, not tool selection. While the name 'postDocumentParts' implies creation, an agent could benefit from a note like 'use this to add new parts to an existing document' or a pointer to getDocumentParts for reading existing parts. The absence of any comparison to siblings leaves usage context under-specified.

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

Deploy Server