Polarion MCP Server

importWordDocument

Imports a Word document to create a new Polarion document. Use dry_run to preview the exact request before sending.

Instructions

Imports a Word document to create a new Polarion 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

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	Multipart form data with 'file' (binary .docx) and 'parameters' (JSON object with documentName, title, documentType, and optional configurationId).

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

AddedSep 7, 2026

TDQS

A4.7/5.0

Behavior5/5

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

The description adds substantial behavioral detail beyond annotations: it explains that the tool triggers a server-side action, that repeated execution may be unsafe, a no-op, or rejected, and that dry-run previews come back as error-flagged results. This is all valuable context that the annotations alone do not provide.

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 organized with a clear purpose statement, an effect warning, and a practical tip. Every sentence earns its place; the dry-run and error-flag notes are dense but relevant, with no unnecessary filler.

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?

For a server-side import tool with an output schema, the description covers the key operational caveats: non-idempotency, dry-run behavior, and how to interpret error-flagged previews. It does not need to describe return values because an output schema exists, and the available context is sufficient 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 parameters are already well documented. The description adds extra meaning specifically for `dry_run`, explaining that it previews the exact request without changing anything, which improves the agent's understanding of that parameter.

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 the action: 'Imports a Word document to create a new Polarion Document.' It further distinguishes the tool from a 'plain resource creation' by explaining that it triggers a server-side action, which helps an agent understand this is a specialized import operation rather than a generic create.

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

Usage Guidelines4/5

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

The description gives clear operational guidance, including a concrete suggestion to set `dry_run: true` first and a warning that idempotency is not guaranteed. It does not explicitly name alternatives like postDocuments or state when not to use this tool, so it misses the full 5, but the context is clear and actionable.

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

Deploy Server