Polarion MCP Server

postDocumentComments

Creates comments on a Polarion LiveDoc and returns the created comment resources. Requires write access; set dry_run to validate and preview the request before sending.

Instructions

Creates comments on one LiveDoc and returns the created comment resources. Requires write access to the document. Use getDocumentComments to read document comments; use postComments for Work Item comments. 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 Comment(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/MyCommentId"
```

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/comments/MyCommentId?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_comments"
-]
```

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/MyCommentId",
+            "type": "string"
+          },
+          "links": {
+            "properties": {
+              "self": {
+                "example": "server-host-name/application-path/projects/MyProjectId/spaces/MySpaceId/documents/MyDocumentId/comments/MyCommentId?revision=1234",
+                "type": "string"
+              }
+            },
+            "type": "object"
+          },
+          "type": {
+            "enum": [
+              "document_comments"
+            ],
+            "type": "string"
+          }
+        },
+        "type": "object"
+      },
+      "type": "array"
+    }
+  },
+  "type": "object"
+}

Changed1 schema field 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"
+}

First observedv1.0.0Jun 13, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Beyond the annotations (readOnlyHint=false, idempotentHint=false), the description explains the non-idempotent behavior ('repeating this call may create additional resources'), the write-access requirement, and the dry_run preview mechanism, all consistent with annotations. Adds real behavioral context.

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 core action, followed by alternatives and behavioral notes. Every sentence carries information, though the dry_run tip is somewhat dense; overall efficient and well-ordered.

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?

Complete for a mutation tool: purpose, alternatives, prerequisites, idempotency, dry_run, and return of created resources are all covered, and an output schema exists so return format needn't be repeated.

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, but the description adds value by explaining that dry_run validates arguments and previews the exact request and how the executor surfaces that preview (text and structured content). Slight extra beyond the schema's own dry_run description.

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: 'Creates comments on one LiveDoc and returns the created comment resources.' It explicitly distinguishes itself from getDocumentComments (reading) and postComments (Work Item comments), so an agent can differentiate without opening schemas.

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?

Explicitly names the alternatives and the conditions that select them ('use getDocumentComments to read', 'use postComments for Work Item comments'), states the write-access prerequisite, and recommends dry_run: true first. When-to-use and when-not-to-use are both covered.

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

Deploy Server